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

FreeBSD Manual Pages

  
 
  

home | help
Toader::Render::AutoDoUserlContributed PerlToader::Render::AutoDoc::Cleanup(3)

NAME
       Toader::Render::AutoDoc::Cleanup	- This is used for cleaning up the
       output directory	prior to rendering.

VERSION
       Version 0.1.0

SYNOPSIS
METHODS
   new
       This initiates the object.

       One argument is required	and it is a Toader object.

	       my $foo=Toader::Render::AutoDoc::Cleanup->new($toader);
	   if($foo->error){
	       warn('error: '.$foo->error.":".$foo->errorString);
	   }

   cleanup
       This cleans up the output directory for a specified object.

       One argument is taken and that is the object to be cleaned from the
       output directory.

	   $foo->cleanup( $obj );
	   if($foo->error){
	       warn('error: '.$foo->error.":".$foo->errorString);
	   }

ERROR CODES
   1, noToaderObj
       No Toader object	passed.

   2, notAtoaderObj
       The passed object is not	a Toader object.

   3, toaderPerror
       The Toader object passed	has a permanent	error set.

   4, notApageObj
       The passed object is not	a Toader::Page object.

   5, noObj
       No object passed.

   6, noOutputDirSet
       The Toader object has not had a output directory	set.

   7, outputDirDoesNotExist
       The output directory does not appear to exist or	is not a directory.

   8, objPerror
       The object has a	permanent error	set.

   9, noDirSet
       The object has not had a	directory set for it.

   10, pathhelperErrored
       Toader::pathHelper errored.

   11, autodocsDirCleanupFailed
       Failed to clean the autodocs directory.

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::Render::Page::Cleanup

       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-04-2Toader::Render::AutoDoc::Cleanup(3)

NAME | VERSION | SYNOPSIS | 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::Render::AutoDoc::Cleanup&sektion=3&manpath=FreeBSD+12.1-RELEASE+and+Ports>

home | help