/ 
Toader-1.2.1
River stage zero No dependents
/ Toader::Render::AutoDoc

NAME

Toader::Render::AutoDoc - This renders a Toader::AutoDoc object.

VERSION

Version 0.2.1

SYNOPSIS

METHODS

new

This initiates the object.

args hash ref

obj

This is the Toader::AutoDoc object to render.

toader

This is the Toader object to use.

toDir

This is the value used to get from the directory it is being rendered in back to directory storing stuff for that directory. By default this is '../'.

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

content

This renders the content to be included in a static page.

my $content=$foo->content;

render

This renders the object.

No arguments are taken.

ERROR CODES

1, noObj

No Toader::AutoDoc object specified.

2, noToaderObj

No Toader object specified.

3, objPerror

The Toader::AutoDoc object has a permanent error set.

4, toaderObjPerror

The Toader object has a permanent error set.

5, noDirSet

The Toader::AutoDoc object does not have a directory set

6, cleanupNewErrored

Failed to initialize the cleanup module.

7, cleanupErrored

Failed to cleanup.

8, fileListFailed

Failed to get a list of files.

9, pathhelperNewErrored

Failed to initialize the path helper.

11, noOutputDirSet

The Toader object does not have a output directory set.

12, outputDirDoesNotExist

The output directory does not exist.

13, outputPageDirCreationFailed

The output page directory could not be created.

14, outputFileDirCreationFailed

The output file directory could not be created.

15, makePathFailed

make_path failed.

16, copyFailed

Failed to copy the HTML produced from the POD to where it belongs.

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::AutoDoc

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.