puppet strings

Author: garrettrowell

examples/hiera/modules/ntp/manifests/config.pp

@@ -1,3 +1,12 @@
+# @summary Manage /tmp/ntp.conf file
+#
+# Given an array of ntpservers, manage the /tmp/ntp.conf file
+#
+# @example
+#   include ntp::config
+#
+# @param ntpservers
+#   An array of ntpserver(s) that should be present in the conf file
 class ntp::config(
   Array[String[1], 1] $ntpservers = undef,
 ) {

examples/hiera/modules/users/manifests/common.pp

@@ -1,3 +1,9 @@
+# @summary Notify to demonstrate users::common in catalog
+#
+# A common Class that all examples should include
+#
+# @example
+#   include users::common
 class users::common {
   notify { 'Adding users::common': }
 }

examples/hiera/modules/users/manifests/dc1.pp

@@ -1,3 +1,9 @@
+# @summary Notify to demonstrate users::dc1 in catalog
+#
+# A Class that should be present in dc1 node(s) catalog
+#
+# @example
+#   include users::dc1
 class users::dc1 {
   notify { 'Adding users::dc1': }
 }