Linux Kernel Phailure in Gnome.
Cool, but please no comments.
How to generate user documentation from Perl script?
If you want to generate user documentation from POD in Perl should add at the bottom of script this section - after keyword __END__(this is only example - I use this schema for my documentation):
i
#!/usr/bin/perl
print "hello world!\n";
# end of script
# TAGS IN PERLDOC:
# *PROGNAME* - replace with program name
# *SHORT_DESCRIPTION* - one sentence description
__END__
=head1 NAME
*PROGNAME* - *SHORT_DESRIPTION*.
=head1 SYNOPSIS
*PROGNAME*
=head1 EXAMPLES
*PROGNAME*
=head1 REQUIRED ARGUMENTS
=head1 OPTIONS
=over 4
=item B<-v, --verbose>
Be verbose
=item B<-d, --debug>
Be even more verbose - information specifig for debugging
=item B<-h, --help>
Display short usage help and exit
=back
=head1 DESCRIPTION
*PROGNAME* was designed for *PURPOSE*
=head1 DEPENDENCIES
=over 4
=item B<perl 5.6> or newer with standard modules
=back
=head1 BUGS AND LIMITATIONS
You are welcome to send bug reports about *PROGNAME* to my ema…
Comments
Post a Comment