I have a module file that includes packages for helper classes. In outline the file looks something like:
use strict;
use warnings;
package Segment;
sub new {
...;
}
sub Describe {
...;
}
package ELF::File;
sub new {
...;
}
sub Describe {
...;
}
=pod
=head1 NAME
ELF::File
=head1 VERSION
...
=head1 USAGE
=item C<new(%params)>
C<new(...)> creates a new ELF::File object and parses the Program Head
+er table
and the Section Header table.
=item C<Describe()>
C<Describe()> returns a multi-line string describing the ELF file head
+er
contents.
...
=cut
Pod::Coverage is happy enough with the ELF::File package, but doesn't see the Segment package. Is there a way to convince Pod::Coverage to notice extra packages in a module and process them? I could move the helpers out into other module files, but that gets pretty silly for some of the helper classes. ELF::File returns helper class objects for some purposes so it is important that their public methods are documented.
Optimising for fewest key strokes only makes sense transmitting to Pluto or beyond
-
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.
|