Index: unk/doc/misc/Foo.pm =================================================================== --- /trunk/doc/misc/Foo.pm (revision 3041) +++ (revision ) @@ -1,31 +1,0 @@ -# Copyright (C) 2004 Author's Name -# -# $Id$ - -package Foo; - -use 5.008005; # optional - -use strict; # not optional -use warnings; # not optional - -our $VERSION = '0.01'; # this is version 0.01 - -use base qw( Baz ); # become a subclass of Baz - -use Foo qw( $bar ); # import $bar into our namespace - -use constant MAXFOO => 3; # maximum number of foos - -our $bar; # is a package variable - -my $baz; # is a package scoped lexical variable - -sub fuu -{ - -} - -1; - -__END__ Index: unk/doc/misc/Foo.pod =================================================================== --- /trunk/doc/misc/Foo.pod (revision 3041) +++ (revision ) @@ -1,96 +1,0 @@ -=pod - -=head1 NAME - -Foo - Does something with Baz. - -=head1 SYNOPSIS - - use Foo; - - ... - -=head1 DESCRIPTION - -=head1 USAGE - -=head2 Import Parameters - -This module accepts no arguments to it's C method and exports no -I. - -=head2 Methods - -=head3 Constructors - -=over 4 - -=item * new - -=back - -=head3 Object Methods - -=over 4 - -=item * foo - -=back - -=head3 Class Methods - -=over 4 - -=item * bar - -=back - -=head3 Destructors - -=over 4 - -=item * DESTROY - -=back - -=head1 DEVELOPER NOTES - -=head2 REFERENCES - -=head1 CREDITS - -Just me, myself, and I. - -=head1 SUPPORT - -Where to get help. - -=head1 AUTHOR - -Principle authors and contact info. - -=head1 COPYRIGHT - -Copyright (C) 2004 Author's Name. All rights reserved. - -This program is free software; you can redistribute it and/or modify it under -the terms of the GNU General Public License as published by the Free Software -Foundation; either version 2 of the License, or (at your option) any later -version. - -This program is distributed in the hope that it will be useful, but WITHOUT ANY -WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A -PARTICULAR PURPOSE. See the GNU General Public License for more details. - -You should have received a copy of the GNU General Public License along with -this program; if not, write to the Free Software Foundation, Inc., 59 Temple -Place - Suite 330, Boston, MA 02111-1307, USA. - -The full text of the license can be found in the LICENSE file included with -this module, or in the L Pod as supplied with Perl 5.8.1 and later. - -=head1 SEE ALSO - -L - -=cut Index: unk/doc/misc/foo.pl =================================================================== --- /trunk/doc/misc/foo.pl (revision 3041) +++ (revision ) @@ -1,89 +1,0 @@ -#!/usr/bin/perl - -# Copyright (C) 2004 Author's Name -# -# $Id$ - -use 5.008005; # optional - -use strict; # not optional -use warnings; # not optional - -our $VERSION = '0.01'; # optional - handy with Getopt::Long - -use Foo qw( $bar ); # import $bar into our namespace - -use constant MAXFOO => 3; # maximum number of foos - -my $baz; # is a lexical variable in the top level scope - -sub fuu -{ - -} - -__END__ - -=pod - -=head1 NAME - -foo.pl - Does something with Baz. - -=head1 SYNOPSIS - - foo.pl --baz - - ... - -=head1 DESCRIPTION - -=head1 OPTIONS - -=over 4 - -=item * --baz - -=back - -=head1 DEVELOPER NOTES - -=head1 REFERENCES - -=head1 CREDITS - -Just me, myself, and I. - -=head1 SUPPORT - -Please contact the author directly via e-mail. - -=head1 AUTHOR - -Principle authors and contact info. - -=head1 COPYRIGHT - -Copyright (C) 2004 Author's Name. All rights reserved. - -This program is free software; you can redistribute it and/or modify it under -the terms of the GNU General Public License as published by the Free Software -Foundation; either version 2 of the License, or (at your option) any later -version. - -This program is distributed in the hope that it will be useful, but WITHOUT ANY -WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A -PARTICULAR PURPOSE. See the GNU General Public License for more details. - -You should have received a copy of the GNU General Public License along with -this program; if not, write to the Free Software Foundation, Inc., 59 Temple -Place - Suite 330, Boston, MA 02111-1307, USA. - -The full text of the license can be found in the L Pod as supplied -with Perl 5.8.1 and later. - -=head1 SEE ALSO - -L - -=cut Index: /trunk/doc/misc/perlCodeConventions.tex =================================================================== --- /trunk/doc/misc/perlCodeConventions.tex (revision 3041) +++ /trunk/doc/misc/perlCodeConventions.tex (revision 3042) @@ -1,3 +1,3 @@ -%%% $Id: perlCodeConventions.tex,v 1.43 2004-12-02 04:17:05 jhoblitt Exp $ +%%% $Id: perlCodeConventions.tex,v 1.44 2005-01-18 23:25:08 jhoblitt Exp $ \documentclass[panstarrs]{panstarrs} @@ -1495,15 +1495,15 @@ \label{foo.pl} -\verbatiminput{foo.pl} +\verbatiminput{perlCodeExamples/foo.pl} \subsection{Module File Example} \label{Foo.pm} -\verbatiminput{Foo.pm} +\verbatiminput{perlCodeExamples/Foo.pm} \subsection{Pod File Example} \label{Foo.pod} -\verbatiminput{Foo.pod} +\verbatiminput{perlCodeExamples/Foo.pod} \subsection{Complete Program Example} Index: /trunk/doc/misc/perlCodeExamples/Foo.pm =================================================================== --- /trunk/doc/misc/perlCodeExamples/Foo.pm (revision 3042) +++ /trunk/doc/misc/perlCodeExamples/Foo.pm (revision 3042) @@ -0,0 +1,31 @@ +# Copyright (C) 2004 Author's Name +# +# $Id: Foo.pm,v 1.1 2005-01-18 23:25:09 jhoblitt Exp $ + +package Foo; + +use 5.008005; # optional + +use strict; # not optional +use warnings; # not optional + +our $VERSION = '0.01'; # this is version 0.01 + +use base qw( Baz ); # become a subclass of Baz + +use Foo qw( $bar ); # import $bar into our namespace + +use constant MAXFOO => 3; # maximum number of foos + +our $bar; # is a package variable + +my $baz; # is a package scoped lexical variable + +sub fuu +{ + +} + +1; + +__END__ Index: /trunk/doc/misc/perlCodeExamples/Foo.pod =================================================================== --- /trunk/doc/misc/perlCodeExamples/Foo.pod (revision 3042) +++ /trunk/doc/misc/perlCodeExamples/Foo.pod (revision 3042) @@ -0,0 +1,96 @@ +=pod + +=head1 NAME + +Foo - Does something with Baz. + +=head1 SYNOPSIS + + use Foo; + + ... + +=head1 DESCRIPTION + +=head1 USAGE + +=head2 Import Parameters + +This module accepts no arguments to it's C method and exports no +I. + +=head2 Methods + +=head3 Constructors + +=over 4 + +=item * new + +=back + +=head3 Object Methods + +=over 4 + +=item * foo + +=back + +=head3 Class Methods + +=over 4 + +=item * bar + +=back + +=head3 Destructors + +=over 4 + +=item * DESTROY + +=back + +=head1 DEVELOPER NOTES + +=head2 REFERENCES + +=head1 CREDITS + +Just me, myself, and I. + +=head1 SUPPORT + +Where to get help. + +=head1 AUTHOR + +Principle authors and contact info. + +=head1 COPYRIGHT + +Copyright (C) 2004 Author's Name. All rights reserved. + +This program is free software; you can redistribute it and/or modify it under +the terms of the GNU General Public License as published by the Free Software +Foundation; either version 2 of the License, or (at your option) any later +version. + +This program is distributed in the hope that it will be useful, but WITHOUT ANY +WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A +PARTICULAR PURPOSE. See the GNU General Public License for more details. + +You should have received a copy of the GNU General Public License along with +this program; if not, write to the Free Software Foundation, Inc., 59 Temple +Place - Suite 330, Boston, MA 02111-1307, USA. + +The full text of the license can be found in the LICENSE file included with +this module, or in the L Pod as supplied with Perl 5.8.1 and later. + +=head1 SEE ALSO + +L + +=cut Index: /trunk/doc/misc/perlCodeExamples/foo.pl =================================================================== --- /trunk/doc/misc/perlCodeExamples/foo.pl (revision 3042) +++ /trunk/doc/misc/perlCodeExamples/foo.pl (revision 3042) @@ -0,0 +1,89 @@ +#!/usr/bin/perl + +# Copyright (C) 2004 Author's Name +# +# $Id: foo.pl,v 1.1 2005-01-18 23:25:09 jhoblitt Exp $ + +use 5.008005; # optional + +use strict; # not optional +use warnings; # not optional + +our $VERSION = '0.01'; # optional - handy with Getopt::Long + +use Foo qw( $bar ); # import $bar into our namespace + +use constant MAXFOO => 3; # maximum number of foos + +my $baz; # is a lexical variable in the top level scope + +sub fuu +{ + +} + +__END__ + +=pod + +=head1 NAME + +foo.pl - Does something with Baz. + +=head1 SYNOPSIS + + foo.pl --baz + + ... + +=head1 DESCRIPTION + +=head1 OPTIONS + +=over 4 + +=item * --baz + +=back + +=head1 DEVELOPER NOTES + +=head1 REFERENCES + +=head1 CREDITS + +Just me, myself, and I. + +=head1 SUPPORT + +Please contact the author directly via e-mail. + +=head1 AUTHOR + +Principle authors and contact info. + +=head1 COPYRIGHT + +Copyright (C) 2004 Author's Name. All rights reserved. + +This program is free software; you can redistribute it and/or modify it under +the terms of the GNU General Public License as published by the Free Software +Foundation; either version 2 of the License, or (at your option) any later +version. + +This program is distributed in the hope that it will be useful, but WITHOUT ANY +WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A +PARTICULAR PURPOSE. See the GNU General Public License for more details. + +You should have received a copy of the GNU General Public License along with +this program; if not, write to the Free Software Foundation, Inc., 59 Temple +Place - Suite 330, Boston, MA 02111-1307, USA. + +The full text of the license can be found in the L Pod as supplied +with Perl 5.8.1 and later. + +=head1 SEE ALSO + +L + +=cut