Christopher Fields > BioPerl > check_NAMEs.pl

Download:
BioPerl-1.6.924.tar.gz

Annotate this POD

CPAN RT

New  9
Open  4
View/Report Bugs
Source  

NAME ^

check_NAMEs.pl - check NAME in module POD has fully qualified object name

SYNOPSIS ^

check_NAMEs.pl [-d|--dir path] [-v|--verbose] [-?|-h|--help]

DESCRIPTION ^

This script is designed to find all Bioperl modules which don't have the fully qualified object name with correct capitalization in the "NAME" section of the POD.

The full name is required for the PDOC POD to HTML script to correctly render the module documentation.

OPTIONS ^

-d | --dir path

Overides the default directory to recursively look for .pm file (Default is '../Bio')

-v | --verbose

Show the progress through files during the POD checking.

-? | -h | --help

This help text.

FEEDBACK ^

Mailing Lists

User feedback is an integral part of the evolution of this and other Bioperl modules. Send your comments and suggestions preferably to the Bioperl mailing list. Your participation is much appreciated.

  bioperl-l@bioperl.org                  - General discussion
  http://bioperl.org/wiki/Mailing_lists  - About the mailing lists

Reporting Bugs

Report bugs to the Bioperl bug tracking system to help us keep track of the bugs and their resolution. Bug reports can be submitted via the web:

  https://github.com/bioperl/bioperl-live/issues

AUTHOR - Torsten Seemann ^

Email: torsten-dot-seemann-at-infotech-dot-monash-dot-edu-dot-au

syntax highlighting: