But unfortunately the rdoc style is extremely verbose and cumbersome to write and maintain. There is pocco as well: http://nanliu.github.io/puppet-pocco/
But some tool like yardoc for puppet would be pretty nice IMO. On 19 April 2013 12:43, Johan De Wit <[email protected]> wrote: > On 04/19/2013 03:09 AM, Rags wrote: > >> From what I read, there is no way to add descriptions (baring putting a >> comment) to class parameters. This would be good to have. Especially in a >> way that external tools can programmatically get hold of parameter list >> along with descriptions... >> >> Thanks Rags >> -- >> You received this message because you are subscribed to the Google Groups >> "Puppet Developers" group. >> To unsubscribe from this group and stop receiving emails from it, send an >> email to >> puppet-dev+unsubscribe@**googlegroups.com<puppet-dev%[email protected]> >> . >> To post to this group, send email to [email protected]. >> Visit this group at >> http://groups.google.com/**group/puppet-dev?hl=en<http://groups.google.com/group/puppet-dev?hl=en> >> . >> For more options, visit >> https://groups.google.com/**groups/opt_out<https://groups.google.com/groups/opt_out> >> . >> >> >> The style guides describes the preferred way to document your classes : > > http://docs.puppetlabs.com/**guides/style_guide.html#**puppet-doc<http://docs.puppetlabs.com/guides/style_guide.html#puppet-doc> > > -- > Johan De Wit > > Open Source Consultant > Red Hat Certified Engineer (805008667232363) > Puppet Certified Professional 2013 (PCP0000006) > ______________________________**___________________________ > > Open-Future Phone +32 (0)2/255 70 70 > Zavelstraat 72 Fax +32 (0)2/255 70 71 > 3071 KORTENBERG Mobile +32 (0)474/42 40 73 > BELGIUM http://www.open-future.be > ______________________________**___________________________ > > > -- > You received this message because you are subscribed to the Google Groups > "Puppet Developers" group. > To unsubscribe from this group and stop receiving emails from it, send an > email to > puppet-dev+unsubscribe@**googlegroups.com<puppet-dev%[email protected]> > . > To post to this group, send email to [email protected]. > Visit this group at > http://groups.google.com/**group/puppet-dev?hl=en<http://groups.google.com/group/puppet-dev?hl=en> > . > For more options, visit > https://groups.google.com/**groups/opt_out<https://groups.google.com/groups/opt_out> > . > > > -- Erik Dalén -- You received this message because you are subscribed to the Google Groups "Puppet Developers" group. To unsubscribe from this group and stop receiving emails from it, send an email to [email protected]. To post to this group, send email to [email protected]. Visit this group at http://groups.google.com/group/puppet-dev?hl=en. For more options, visit https://groups.google.com/groups/opt_out.
