Toader::AutoDoc - Automatically build documentation from specified directories.
Version 0.2.0
This initiates the object.
One argument is required and it is a Toader object.
my $foo = Toader::AutoDoc->new( $toader ); if ( $foo->error ){ warn('error:'.$foo->error.': '.$foo->errorString); }
This gets Toader directory this entry is associated with.
This will only error if a permanent error is set.
This will return undef if no directory has been set.
my $dir=$foo->dirGet; if($foo->error){ warn('Error:'.$foo->error.': '.$foo->errorString); }
This sets Toader directory this entry is associated with.
One argument is taken and it is the Toader directory to set it to.
my $dir=$foo->dirSet($toaderDirectory); if($foo->error){ warn('Error:'.$foo->error.': '.$foo->errorString); }
Finds documentation under the specified paths.
This adds a new path.
Remove a specified path.
This gets the list of what is to by handled.
No arguments are taken.
The returned value is a list. Each item in the list is a path to recursively search.
my @paths=$foo->pathsGet;
This sets the AutoDoc paths for a directory.
One argument is required and that is a array ref of relative paths.
$foo->pathsSet( \@paths );
This verifies that a path is valid.
It makes sure it defined and does not match any thing below.
^..\/ \/..\/ \/..$
This returns the file directory for the object.
This is not a full path, but a partial path that should be appended the directory current directory being outputted to.
This returns the location ID.
This one requires the object to be initialized.
This is the directory that it will be rendered to.
The base directory that will be used for rendering.
This returns the module to use for rendering.
my $module=$foo->renderUsing;
This method returns true and marks it as being Toader renderable.
This returns the relative path to the object.
No directory specified.
The directory is not a Toader directory.
Failed to open the paths file.
No directory set.
No path specified.
Invalid path.
The AutoDoc configuration directory could not be created.
The specified object is not a Toader object.
Toader::VCS->getVCS errored.
Toader::VCS->VCSusable errored.
Toader::VCS->underVCS errored.
Toader::VCS->add errored.
Zane C. Bowers-Hadley, <vvelox at vvelox.net>
<vvelox at vvelox.net>
Please report any bugs or feature requests to bug-toader at rt.cpan.org, or through the web interface at http://rt.cpan.org/NoAuth/ReportBug.html?Queue=Toader. I will be notified, and then you'll automatically be notified of progress on your bug as I make changes.
bug-toader at rt.cpan.org
You can find documentation for this module with the perldoc command.
perldoc Toader::AutoDoc
You can also look for information at:
RT: CPAN's request tracker
http://rt.cpan.org/NoAuth/Bugs.html?Dist=Toader
AnnoCPAN: Annotated CPAN documentation
http://annocpan.org/dist/Toader
CPAN Ratings
http://cpanratings.perl.org/d/Toader
Search CPAN
http://search.cpan.org/dist/Toader/
Copyright 2013 Zane C. Bowers-Hadley.
This program is free software; you can redistribute it and/or modify it under the terms of either: the GNU General Public License as published by the Free Software Foundation; or the Artistic License.
See http://dev.perl.org/licenses/ for more information.
To install Toader, copy and paste the appropriate command in to your terminal.
cpanm
cpanm Toader
CPAN shell
perl -MCPAN -e shell install Toader
For more information on module installation, please visit the detailed CPAN module installation guide.