diff --git a/lib/puppet/module_tool/skeleton/templates/generator/manifests/init.pp.erb b/lib/puppet/module_tool/skeleton/templates/generator/manifests/init.pp.erb index a17c1a689..04dd52583 100644 --- a/lib/puppet/module_tool/skeleton/templates/generator/manifests/init.pp.erb +++ b/lib/puppet/module_tool/skeleton/templates/generator/manifests/init.pp.erb @@ -1,17 +1,41 @@ -# Class: <%= metadata.name %> +# == Class: <%= metadata.name %> # -# This module manages <%= metadata.name %> +# Full description of class <%= metadata.name %> here. # -# Parameters: +# === Parameters # -# Actions: +# Document parameters here. # -# Requires: +# [*sample_parameter*] +# Explanation of what this parameter affects and what it defaults to. +# e.g. "Specify one or more upstream ntp servers as an array." # -# Sample Usage: +# === Variables +# +# Here you should define a list of variables that this module would require. +# +# [*sample_variable*] +# Explanation of how this variable affects the funtion of this class and if it +# has a default. e.g. "The parameter enc_ntp_servers must be set by the +# External Node Classifier as a comma separated list of hostnames." (Note, +# global variables should not be used in preference to class parameters as of +# Puppet 2.6.) +# +# === Examples +# +# class { <%= metadata.name %>: +# servers => [ 'pool.ntp.org', 'ntp.local.company.com' ] +# } +# +# === Authors +# +# Author Name +# +# === Copyright +# +# Copyright 2011 Your name here, unless otherwise noted. # -# [Remember: No empty lines between comments and class definition] class <%= metadata.name %> { }