SUMMARY: CONSTR | METHOD | DETAIL: CONSTR | METHOD |
=begin classdoc
and
=end classdoc
sections. Each such section is associated
with its immediately succeding package or method statement, unless
the @xs
directive is specified, in which case
the classdoc is assumed to be for an external (e.g., XS) method.
Multiple external method classdoc sections may be specified within a single
=pod ... =cut
section, with the final such classdoc section
associated with any trailing method definition.
Class instances are hash references.
Unless otherwise noted, $self
is the object instance variable.
Constructor Summary |
---|
new($path, $title, $verbose)
Creates a new empty Pod::Classdoc object. |
Method Summary |
---|
add($txt, $file)
Scan the provided text for Perl packages, adding the packages to the current collection of classes. |
clear()
Clear this object. |
getFrameContainer($home)
Generate a toplevel container document for the TOC and classdoc frames. |
getTOC(@order)
Generate a table of contents document for the current collection of classdocs as a nested HTML list. |
makeClassPath($class)
Generate fully qualified pathname of output classdoc file for a given package name. |
new()
|
open($path, $pkg)
Load the specified package file. |
openProject(@projects)
Load all the package files within a specified project directory. |
path($path)
Get or set the output directory path for rendered documents. |
render($use_private)
Render the loaded packages into classdocs. |
writeClassdocs($use_private)
Write out the documents for the current collection of classdocs. |
writeFrameContainer($container, $home)
Write out a toplevel container document for the TOC and classdoc frames. |
writeTOC(@order)
Write out an table of contents document for the current collection of classdocs as a nested HTML list. |
Constructor Details |
---|
new($path, $title, $verbose)
$path | - | (optional)directory path for output documents; default is './classdocs' |
$title | - | (optional)title string to use for head of classdocs |
$verbose | - | (optional)if true, enables diagnostic output (default false) |
Method Details |
---|
add($txt, $file)
$txt | - | the package text as either a scalar string, or an arrayref of the lines of the package |
$file | - | (optional)full path of source file |
clear()
getFrameContainer($home)
$home | - | (optional)pathname of a toplevel document to be included in index |
getTOC(@order)
@order | - | (optional)list of packages in the order in which they should appear in TOC; if a partial list, any remaining packages will be appended to the TOC in alphabetical order |
makeClassPath($class)
$class | - | package name to be resolved to output classdoc file |
new()
open($path, $pkg)
$path | - | path to the package file. |
$pkg | - | Perl name of the package |
openProject(@projects)
@projects | - | list of pathnames of root project directories |
path($path)
$path | - | (optional)root directory where classdocs are to be written; if not provided, a Get operation is executed @returns for a Get operation, the current output path; for a Set operation, the prior output path |
render($use_private)
$use_private | - | (optional)include private methods. By default, only public methods are included in the output; setting this flag causes any documented private methods (methods beginning with an underscore) to be included as well. Note that constructors are always considered public. @returns on success, a hashref mapping classnames to an arrayref of the classdoc formatted output, the input source file name and line number of the class's associated classdoc'd package definition, and a hashref mapping method names to an arrayref of source file name and linenumber; undef on failure, with error message in $@ |
writeClassdocs($use_private)
$use_private | - | (optional)include private methods. By default, only public methods are included in the output; setting this flag causes any documented private methods (methods beginning with an underscore) to be included as well. Note that constructors are always considered public. |
writeFrameContainer($container, $home)
$container | - | name of output file without path; path is taken
from the path specified via |
$home | - | (optional)pathname of a toplevel document to be included in index |
writeTOC(@order)
@order | - | (optional)list of packages in the order in which they should appear in TOC; if a partial list, any remaining packages will be appended to the TOC in alphabetical order |