Lines Matching full:documentation

7 These are general guidelines for how to write POD documentation for Perl
10 them will make your documentation more consistent with other documentation
23 when referring to module documentation since it's not clear what section
24 module documentation will be in; use C<LE<lt>Module::NameE<gt>> for module
30 to clutter your documentation with too much markup.  References to other
64 mandatory for section 3 pages.  For Perl module documentation, it's
71 body of the documentation for man pages that document something else.  If
81 or whatever is appropriate for your documentation.
83 For a module, this is generally where the documentation of the interfaces
86 you may want to put that documentation in separate METHODS, FUNCTIONS,
120 useful to discuss return values separately in the documentation of each
126 Typically used for function or module documentation; program documentation
137 may wish to follow the same documentation style as the Perl documentation;
149 often find this the most useful part of the documentation.  The examples
201 have a way of contacting you.  Remember that program documentation tends
244 Documentation of object-oriented libraries or modules may want to use
246 sections, for detailed documentation of the parts of the library and save
267 much easier to later edit the documentation.  Note that many existing
273 Russ Allbery <rra@cpan.org>, with large portions of this documentation
274 taken from the documentation of the original B<pod2man> implementation by
295 This documentation is maintained as part of the podlators distribution.