Skip to content

Commit

Permalink
(PDOC-161) Update README with an example usage of the summary tag
Browse files Browse the repository at this point in the history
  • Loading branch information
whopper committed Mar 16, 2017
1 parent 4990576 commit 8178c0b
Showing 1 changed file with 3 additions and 0 deletions.
3 changes: 3 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
#
# @summary A short summary of the purpose of the class.
#
# @example Declaring the class
# include example
#
Expand All @@ -206,6 +208,7 @@ class example_class(
The Strings elements appearing in the above comment block are:

* 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 `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.
Expand Down

0 comments on commit 8178c0b

Please # to comment.