Bug #10702
Puppetdoc does not generate documentation for parameterized class parameters.
| Status: | Needs More Information | Start date: | 11/10/2011 | |
|---|---|---|---|---|
| Priority: | Normal | Due date: | ||
| Assignee: | - | % Done: | 0% |
|
| Category: | - | |||
| Target version: | 2.7.x | |||
| Affected Puppet version: | Branch: | |||
| Keywords: | puppetdoc | |||
| Votes: | 0 |
Description
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.
Related issues
History
Updated by Kelsey Hightower 6 months ago
- Status changed from Unreviewed to Needs More Information
Thanks for reporting this issue, in order to start investigating this issue can you provide the following bits of information?
- puppet version you are using
- basic OS details
Updated by Lars Kellogg-Stedman 6 months ago
- Target version set to 2.7.x
I’m using 2.7.6, and the problem does not appear to be OS specific (I’ve tried under Fedora, CentOS, OS X, and FreeBSD).