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...)
-
Are you posting in the right place? Check out Where do I post X? to know for sure.
-
Posts may use any of the Perl Monks Approved HTML tags. Currently these include the following:
<code> <a> <b> <big>
<blockquote> <br /> <dd>
<dl> <dt> <em> <font>
<h1> <h2> <h3> <h4>
<h5> <h6> <hr /> <i>
<li> <nbsp> <ol> <p>
<small> <strike> <strong>
<sub> <sup> <table>
<td> <th> <tr> <tt>
<u> <ul>
-
Snippets of code should be wrapped in
<code> tags not
<pre> tags. In fact, <pre>
tags should generally be avoided. If they must
be used, extreme care should be
taken to ensure that their contents do not
have long lines (<70 chars), in order to prevent
horizontal scrolling (and possible janitor
intervention).
-
Want more info? How to link
or How to display code and escape characters
are good places to start.
|
