new

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

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

pathAdd

pathRemove

pathsGet

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

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

    $foo->pathsSet( \@paths );

validPath

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

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

filesDir

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

locationID

This one requires the object to be initialized.

renderDir

The base directory that will be used for rendering.

renderUsing

    my $module=$foo->renderUsing;

toaderRenderable

toDir

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

1, noDirSpecified

2, notAtoaderDir

3, pathsFileOpenFailed

4, noDirSet

5, noPathSpecified

6, invalidPath

7, dirCreationFailed

8, notAtoaderObj

9, getVCSerrored

10, VCSusableFailedErrored

11, underVCSerrored

12, VCSaddErrored

13, noToaderObj