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

[download]

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

[download]

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

In reply to Re: Guidelines for listing functions/methods in POD? by stevieb
in thread Guidelines for listing functions/methods in POD? by Dallaylaen

Title:
Use:  <p> text here (a paragraph) </p>
and:  <code> code here </code>
to format your post, it's "PerlMonks-approved HTML":


  • Posts are HTML formatted. Put <p> </p> tags around your paragraphs. Put <code> </code> tags around your code and data!
  • Titles consisting of a single word are discouraged, and in most cases are disallowed outright.
  • Read Where should I post X? if you're not absolutely sure you're posting in the right place.
  • Please read these before you post! —
  • Posts may use any of the Perl Monks Approved HTML tags:
    a, abbr, b, big, blockquote, br, caption, center, col, colgroup, dd, del, details, div, dl, dt, em, font, h1, h2, h3, h4, h5, h6, hr, i, ins, li, ol, p, pre, readmore, small, span, spoiler, strike, strong, sub, summary, sup, table, tbody, td, tfoot, th, thead, tr, tt, u, ul, wbr
  • You may need to use entities for some characters, as follows. (Exception: Within code tags, you can put the characters literally.)
            For:     Use:
    & &amp;
    < &lt;
    > &gt;
    [ &#91;
    ] &#93;
  • Link using PerlMonks shortcuts! What shortcuts can I use for linking?
  • See Writeup Formatting Tips and other pages linked from there for more info.