Multi-Lingual Library

Maintainability

Perl

Java

JavaScript

Certified Class

Testable Class

Standalone Mode

Diagnostic Enabled

• NAME
• SYNOPSIS
• OPTIONS
• REQUIRES
• DESCRIPTION
• BUGS
• TO BE DONE
• AUTHOR
• VERSION
• SINCE
• SEE ALSO
• POD ERRORS

NAME

addpod - Add POD comments for each function in a module.

SYNOPSIS

    addpod filename...

OPTIONS

-h

Option help.

-H

Long help (manual page).

REQUIRES

Perl5.005, HTML::Template

DESCRIPTION

This utility assists in creating documentation in POD format for Perl files. For each function in the file, it will add a skeleton POD section immediately preceding it, providing a series of "blanks" to be filled in for each argument, the return value, the function description, and the function invocation. The entire file is returned on STDOUT with the added POD comments. The template for the skeleton itself is contained within this utility.

Note that this is not a complete POD skeleton, only for documenting the functions themselves. You will still need to add all the standard file-level documentation.

Also note that this utility differentiates (simplistically) between public and private functions. Any function name beginning with an underscore is skipped.

BUGS

None

TO BE DONE

Store result back in file of the same name, allowing for easier handling of multiple files.

AUTHOR

Michael Sorens

VERSION

$Revision: 8 $ $Date: 2006-12-19 21:13:43 -0800 (Tue, 19 Dec 2006) $

SINCE

CleanCode 0.9

SEE ALSO

perl(1)

<TMPL_VAR name>

<TMPL_IF oom>OBJ-></TMPL_IF><TMPL_VAR name>(<TMPL_LOOP items><TMPL_VAR item><TMPL_UNLESS __LAST__>, </TMPL_UNLESS></TMPL_LOOP items>)

Purpose TBD

<TMPL_IF items>=item Parameters:

<TMPL_LOOP items><TMPL_VAR item> - optional; string; TBD

</TMPL_LOOP items></TMPL_IF items>=item Returns:

TBD

POD ERRORS

Hey! The above document had some coding errors, which are explained below:

Around line 179:

'=item' outside of any '=over'

CleanCode Perl Libraries

Copyright © 2001-2013 Michael Sorens - Revised 2013.06.30