this is the pattern, i can't think of an example ATM, but this is the pattern, seen it a million times, with non-ambiguous optional args documentation

=head1 NAME Foo::Bar - the best foo you can bar =head2 Foo::Bar::Baz The baz of the bar in the foo =head3 Foo::Bar::Baz->new =head3 $baz->qux =head3 $baz->qux( $slice ) =head3 $baz->qux( $slice, $thickness ) Its delicious, takes no args, one arg, or two args =head2 Foo::Bar::Norf =head3 Foo::Bar::Norf->new =head3 $norf->qux =head3 $norf->qux( $barf ) =head3 $norf->qux( $barf, $taffy ) Norf norf norf norf norf barf! =cut

update: http://grep.cpan.me/?q=%3Dhead2.*%3F-%3Enew&page=5

https://metacpan.org/search?q=%3A%3Areader+%3A%3Awriter&size=20&search_type=modules -> XML::Tape

update: from memory, XML::Twig, but its HUGE and a tutorial

Simplifying XML processing NAME ... ... ... CLASSES METHODS XML::Twig XML::Twig::Elt cond XML::Twig::XPath XML::Twig::XPath::Elt XML::Twig::Entity_list ...

I like all the methods showing up in TOC


In reply to Re^3: Organizing POD for an XS++ module by Anonymous Monk
in thread Organizing POD for an XS++ module by jdv

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.