Author: jkeenan Date: Sun Jan 28 20:29:49 2007 New Revision: 16828 Modified: branches/buildtools/lib/Parrot/Ops2pm/Auxiliary.pm
Log: Wrote documentation in POD format for package and its two exportable subroutines. Modified: branches/buildtools/lib/Parrot/Ops2pm/Auxiliary.pm ============================================================================== --- branches/buildtools/lib/Parrot/Ops2pm/Auxiliary.pm (original) +++ branches/buildtools/lib/Parrot/Ops2pm/Auxiliary.pm Sun Jan 28 20:29:49 2007 @@ -27,3 +27,87 @@ 1; +#################### DOCUMENTATION #################### + +=head1 NAME + +Parrot::Ops2pm::Auxiliary - Non-method subroutines holding functionality for F<tools/build/ops2pm.pl>. + +=head1 SYNOPSIS + + use Parrot::Ops2pm::Auxiliary qw( Usage getoptions ); + + Usage(); + + $flagref = getoptions(); + +=cut + +=head1 DESCRIPTION + +Parrot::Ops2pm::Auxiliary provides subroutines called by F<tools/build/ops2pm.pl>, a +program which is called at the very beginning of the Parrot F<make> process. +This package is intended to hold subroutines used by that program I<other +than> the object-oriented methods provided by Parrot::Ops2pm::Utils. + +Extraction of the subroutines exported by this package from +F<tools/build/ops2pm.pl> facilitates the testing of their functionality by the +tests in F<t/tools/ops2pmutils/*.t>. + +=head1 SUBROUTINES + +=head2 C<Usage()> + +=over 4 + +=item Purpose + +Display a short description of how to use F<tools/build/ops2pm.pl> on +standard output. + + usage: tools/build/ops2pm.pl [--help] [--no-lines] input.ops [input2.ops ...] + +=item Arguments + +None. + +=item Return Value + +Implicitly returns true upon successful printing. + +=back + +=head2 C<getoptions> + +=over 4 + +=item Purpose + +Process arguments provided on command-line to F<tools/build/ops2pm.pl>. + +=item Arguments + +None. + +=item Return Value + +Hash reference where any of the following keys may or may not be defined. + + no-lines + help + renum + +=item Comment + +A wrapper around Getopt::Long::GetOptions() designed to assure testability. + +=back + +=head1 AUTHOR + +=head1 SEE ALSO + +Parrot::Ops2pm::Utils. F<tools/build/ops2pm.pl>. + +=cut +
