Beefy Boxes and Bandwidth Generously Provided by pair Networks
We don't bite newbies here... much
 
PerlMonks  

Re: Guidelines for listing functions/methods in POD?

by stevieb (Canon)
on Dec 08, 2017 at 00:33 UTC ( [id://1205135]=note: print w/replies, xml ) Need Help??


in reply to Guidelines for listing functions/methods in POD?

I've been doing this (untested):

=head1 METHODS =head2 blah Does something or other, all params are passed in as a hash. Parameters: one => $str Mandatory, String: Parameter that does X. two => $bool Optional, Bool: Does something else

For functions/methods that take positional parameters (because they aren't many), I often:

=head1 FUNCTIONS =head2 foo($bar, \@$baz) I don't know what this function does. Parameters: $bar Mandatory, Integer: This param enables verbosity. Values: 0-255 \@baz Optional, Array reference of Integers: Used to generate a grid size. Returns: A grid of something as an array reference

Here's an example that contains a bit of both of the above.

Log In?
Username:
Password:

What's my password?
Create A New User
Domain Nodelet?
Node Status?
node history
Node Type: note [id://1205135]
help
Chatterbox?
and the web crawler heard nothing...

How do I use this?Last hourOther CB clients
Other Users?
Others exploiting the Monastery: (6)
As of 2024-04-25 08:16 GMT
Sections?
Information?
Find Nodes?
Leftovers?
    Voting Booth?

    No recent polls found