modinfo2embperl.pl

modinfo2embperl.pl: convert modinfo directives into POD and embed it in a specially marked location in the pm file.

SYNOPSIS

perl modinfo2embperl.pl -m MyModule

or

perl modinfo2html.pl -d /home/jtillman/html-docs/ -m MyModule

EMBEDDING DIRECTIVE

See the documentation for ModInfo to learn how to document your module with ModInfo directives. In order to tell modinfo2embperl where to embed the POD it creates, simply put this in your POD:

        =head1 INTERFACE

And then make sure that the next thing in your pod is another =head1

modinfo2embperl will insert the generated POD between these two markers in your code. Make sure that the = sign is the first character on the line, just as in true POD.

Subsequent runs of the processor will overwrite anything inside these two markers, so don't bother editing the POD by hand.

OPTIONS

-h Display help
-m package Name of the Perl module package to convert (If this is the only option provided, output will go to STDOUT)
-r Recurse through the entire directory structure, looking for .pm files, and process each one

AUTHOR

jtillman@bigfoot.com

tcushard@bigfoot.com

SEE ALSO

ModInfo

Devel::ModInfo::Tutorial

pl2modinfo.pl

modinfo2xml.pl

perl(1)

!NO!SUBS!