kienan
/
puppet-strings
1
0
Fork 0
Code Issues Pull Requests Releases Wiki Activity

(PDOC-161) Update README with an example usage of the summary tag

This commit is contained in:
Will Hopper 2017-03-15 16:43:04 -07:00
parent 4990576f61
commit 8178c0beff
1 changed files with 3 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

3
README.md
View File

@ -190,6 +190,8 @@ To document Puppet classes and defined types, use a series of comments to create
# #
# This is an example of how to document a Puppet class # This is an example of how to document a Puppet class
# #
# @summary A short summary of the purpose of the class.
#
# @example Declaring the class # @example Declaring the class
# include example # include example
# #
@ -206,6 +208,7 @@ class example_class(
The Strings elements appearing in the above comment block are: The Strings elements appearing in the above comment block are:
* Three comment lines, not prefixed with tags, give the class description. * Three comment lines, not prefixed with tags, give the class description.
* The `@summary` YARD tag, which can be used for a short description of the class (fewer than 140 characters recommended).
* The `@example` YARD tag, immediately followed by an optional title. * The `@example` YARD tag, immediately followed by an optional title.
* The `include` statement, which adds the usage example code. * The `include` statement, which adds the usage example code.
* Two `@param` tags, with the name of the parameter first, followed by a string describing the parameter's purpose. * Two `@param` tags, with the name of the parameter first, followed by a string describing the parameter's purpose.