Zane C. Bowers-Hadley > Toader > Toader::Render::AutoDoc::Cleanup

Download:
Toader-1.1.2.tar.gz

Dependencies

Annotate this POD

CPAN RT

New  3
Open  1
View/Report Bugs
Module Version: 0.1.0   Source  

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:

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.

syntax highlighting: