puppet-strings

Commit Graph

Author	SHA1	Message	Date
Charlie Sharpsteen	918e3bc9cc	Tag all functions with @api public The Puppet Core uses a `.yardopts` file that hides all docstrings that do not have an API tag. This patch is a hack that allows `puppet yardoc` to extract documentation for parser functions shipped in the core. FIXME: This isn't the right way to solve the problem. The right way to solve the problem is to adjust the Puppet `.yardopts` file to a sane value.	2014-06-19 16:31:58 -07:00
Charlie Sharpsteen	1b8cc98118	Move parser functions into a PuppetNamespace Seperate Puppet parser functions out into a PuppetNamespace so they are no longer listed with the Ruby methods.	2014-06-12 21:21:11 -07:00
Charlie Sharpsteen	c1217912dd	Add custom YARD handler for parser functions This handler triggers on all occurrences of `newfunction` and parses the parameters passed to that method in order to generate documentation. The implementation is a good experiment in extracting documentation without evaluating Ruby code. However, the generality of this approach may ultimately be doomed by the use of metaprogramming in custom Types and Providers.	2014-06-05 21:40:17 -07:00

Author

SHA1

Message

Date

Charlie Sharpsteen

918e3bc9cc

Tag all functions with @api public

The Puppet Core uses a `.yardopts` file that hides all docstrings that do not
have an API tag. This patch is a hack that allows `puppet yardoc` to extract
documentation for parser functions shipped in the core.

FIXME: This isn't the right way to solve the problem. The right way to solve
the problem is to adjust the Puppet `.yardopts` file to a sane value.

2014-06-19 16:31:58 -07:00

Charlie Sharpsteen

1b8cc98118

Move parser functions into a PuppetNamespace

Seperate Puppet parser functions out into a PuppetNamespace so they are no
longer listed with the Ruby methods.

2014-06-12 21:21:11 -07:00

Charlie Sharpsteen

c1217912dd

Add custom YARD handler for parser functions

This handler triggers on all occurrences of `newfunction` and parses the
parameters passed to that method in order to generate documentation. The
implementation is a good experiment in extracting documentation without
evaluating Ruby code. However, the generality of this approach may ultimately
be doomed by the use of metaprogramming in custom Types and Providers.

2014-06-05 21:40:17 -07:00

3 Commits