Issue #10702 has been reported by Lars Kellogg-Stedman.

----------------------------------------
Bug #10702: Puppetdoc does not generate documentation for parameterized class 
parameters.
https://projects.puppetlabs.com/issues/10702

Author: Lars Kellogg-Stedman
Status: Unreviewed
Priority: Normal
Assignee: 
Category: 
Target version: 
Affected Puppet version: 
Keywords: puppetdoc
Branch: 


Puppetdoc will generate documentation for a defined resource that includes the 
list of available parameters, like this:

    target( $group => 'undef', $mode => 'undef', $header => 'undef', $footer => 
'undef', $target => 'undef', $source => 'undef', $owner => 'undef' )

But there is no documentation generated for the parameters of parameterized 
classes.  For example, given:

    # This is my class with a parameter.
    class concat ( $concat_parts_script = "/usr/sbin/concat-parts") {
    }

The generated documentation includes only the contents of the comment, and no 
indication of the available parameters or their default values.



-- 
You have received this notification because you have either subscribed to it, 
or are involved in it.
To change your notification preferences, please click here: 
http://projects.puppetlabs.com/my/account

-- 
You received this message because you are subscribed to the Google Groups 
"Puppet Bugs" group.
To post to this group, send email to [email protected].
To unsubscribe from this group, send email to 
[email protected].
For more options, visit this group at 
http://groups.google.com/group/puppet-bugs?hl=en.

Reply via email to