Skip site navigation (1)Skip section navigation (2)

FreeBSD Manual Pages

  
 
  

home | help
Toader::AutoDoc(3)    User Contributed Perl Documentation   Toader::AutoDoc(3)

NAME
       Toader::AutoDoc - Automatically build documentation from	specified
       directories.

VERSION
       Version 0.2.0

METHODS
   new
       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);
	   }

   dirGet
       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);
	   }

   dirSet
       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);
	   }

   findDocs
       Finds documentation under the specified paths.

   pathAdd
       This adds a new path.

   pathRemove
       Remove a	specified path.

   pathsGet
       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;

   pathsSet
       This sets the AutoDoc paths for a directory.

       One argument is required	and that is a array ref	of relative paths.

	   $foo->pathsSet( \@paths );

   validPath
       This verifies that a path is valid.

       It makes	sure it	defined	and does not match any thing below.

	   ^..\/
	   \/..\/
	       \/..$

REQUIRED RENDERING METHODS
   filesDir
       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.

   locationID
       This returns the	location ID.

       This one	requires the object to be initialized.

   renderDir
       This is the directory that it will be rendered to.

       The base	directory that will be used for	rendering.

   renderUsing
       This returns the	module to use for rendering.

	   my $module=$foo->renderUsing;

   toaderRenderable
       This method returns true	and marks it as	being Toader renderable.

   toDir
       This returns the	relative path to the object.

       This is not a full path,	but a partial path that	should be appended the
       directory current directory being outputted to.

ERROR CODES
   1, noDirSpecified
       No directory specified.

   2, notAtoaderDir
       The directory is	not a Toader directory.

   3, pathsFileOpenFailed
       Failed to open the paths	file.

   4, noDirSet
       No directory set.

   5, noPathSpecified
       No path specified.

   6, invalidPath
       Invalid path.

   7, dirCreationFailed
       The AutoDoc configuration directory could not be	created.

   8, notAtoaderObj
       The specified object is not a Toader object.

   9, getVCSerrored
       Toader::VCS->getVCS errored.

   10, VCSusableFailedErrored
       Toader::VCS->VCSusable errored.

   11, underVCSerrored
       Toader::VCS->underVCS errored.

   12, VCSaddErrored
       Toader::VCS->add	errored.

   13, noToaderObj
AUTHOR
       Zane C. Bowers-Hadley, "<vvelox at vvelox.net>"

BUGS
       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.

SUPPORT
       You can find documentation for this module with the perldoc command.

	   perldoc Toader::AutoDoc

       You can also look for information at:

       o   RT: CPAN's request tracker

	   <http://rt.cpan.org/NoAuth/Bugs.html?Dist=Toader>

       o   AnnoCPAN: Annotated CPAN documentation

	   <http://annocpan.org/dist/Toader>

       o   CPAN	Ratings

	   <http://cpanratings.perl.org/d/Toader>

       o   Search CPAN

	   <http://search.cpan.org/dist/Toader/>

ACKNOWLEDGEMENTS
LICENSE	AND COPYRIGHT
       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.

perl v5.24.1			  2013-05-11		    Toader::AutoDoc(3)

NAME | VERSION | METHODS | REQUIRED RENDERING METHODS | ERROR CODES | AUTHOR | BUGS | SUPPORT | ACKNOWLEDGEMENTS | LICENSE AND COPYRIGHT

Want to link to this manual page? Use this URL:
<https://www.freebsd.org/cgi/man.cgi?query=Toader::AutoDoc&sektion=3&manpath=FreeBSD+12.1-RELEASE+and+Ports>

home | help