ELF::File returns helper class objects for some purposes so it is important that their public methods are documented.

If it needs to be documented, it needs to be in a separate file so the documentation tools can find it. The ELF::File POD should name the class of the helper object returned, and then that class should be in its own file. TkPod and perldoc will not be able to find that documentation if it is bundled into ELF/File.pm.

The only case where I embed helper classes in the same file is where the helpers are tightly bound to the main class implementation. I did that with the tied array and tied hash helper classes in WARC::Fields, since they actually are dependent on their parent objects. The documentation for the WARC package has a page for it. In this case, the helper classes are not documented at all, but instead their public methods are documented along with the interface that uses them. (I need to get back on that project; I last hit a wall working on the archive-writing code... I wonder if it has simmered long enough on the proverbial back burner yet...)

In reply to Re: Pod::Coverage for helper classes by jcb
in thread Pod::Coverage for helper classes by GrandFather

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.