Zane C. Bowers-Hadley > Toader > toader-autodoc

Download:
Toader-1.1.2.tar.gz

Annotate this POD

CPAN RT

New  3
Open  1
View/Report Bugs
Source  

NAME ^

toader-autodoc - Manipulates Toader's automatic documentation handling.

SYNOPSIS ^

toader-autodoc -a find

toader-autodoc -a pa -p <path>

toader-autodoc -a pg

toader-autodoc -a pr -p <path>

toader-autodoc -a render

SWICHES ^

-a <action>

The action to perform.

-p <path>

The path to use.

ACTIONS ^

find

This returns the relative paths from the current Toader dir for found documentation.

pa

Add the specified path under the current Toader dir.

pg

Gets the autodoc path list.

pr

Removes the specified path under the current Toader dir.

render

Renders it. This requires the environmental variable "Toader_outputdir" be specified.

Environmental Variables ^

Toader_outputdir

The output directory to use.

AUTHOR ^

Copyright (c) 2013, Zame C. Bowers-Hadley <vvelox@vvelox.net>

All rights reserved.

Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met:

    * Redistributions of source code must retain the above copyright notice,
     this list of conditions and the following disclaimer.
    * Redistributions in binary form must reproduce the above copyright
     notice, this list of conditions and the following disclaimer in the
     documentation and/or other materials provided with the distribution.

THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS` OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

OSNAMES ^

unix

README ^

toader-autodoc -

syntax highlighting: