Perl Monk, Perl Meditation | |
PerlMonks |
POD question: listing methodsby John M. Dlugosz (Monsignor) |
on Oct 29, 2002 at 15:33 UTC ( [id://208767]=perlquestion: print w/replies, xml ) | Need Help?? |
John M. Dlugosz has asked for the wisdom of the Perl Monks concerning the following question:
Somewhere in the POD for a module will typically be a list of methods, each one delimited by its own breakhead of some kind (whether =item or =headn). I wanted to put the argument list on the headline too, and that looks fine (see Module Design Review - Exporter::VA). But, that means that L<xref> tags will have to include the exact entire string, which is at the very least a bore and potentially a maintanaince problem. So, I changed some of them to just listing the method name in the headline, and put a illustrative parameter list and return value on the next line as a verbatim paragraph. What's a better way to do it? —John
Back to
Seekers of Perl Wisdom
|
|