gendoc.pl

A script that generate the doc from Murge sources.

Usage

./gendoc.pl -d <NaturalDocsFileDirectory> -n <NaturalDocsExecutable>
   Generate the documentation from Murge sources.
    -h          Shows this help
    -d <dir>    Sources Directory         (Default : ../)
    -i <dir>    Menu/Images Directory     (Default : ./NaturalDocs)
    -n <exe>    NaturalDocs Executable    (Default : NaturalDocs)
    -o <dir>    Defines output directory  (Default : ./doc)
    -p <dir>    Defines project directory (Default : ./pdoc)

Authors

Xavier Lacostelac.nosp@m.oste@labr.nosp@m.i.fr
Summary
gendoc.plA script that generate the doc from Murge sources.
Variables
naturaldocsPath to root of murge sources.
dirsrcPath to root of murge sources.
dirndPath to directory containing images.
outputPath to output directory.
projectPath to project directory.
optsOptions given to the script
Functions
UsagePrints usage.
GenDocGenerates Murge documentation directory.

Variables

naturaldocs

my $naturaldocs

Path to root of murge sources.

dirsrc

my $dirsrc

Path to root of murge sources.

dirnd

my $dirnd

Path to directory containing images.

output

my $output

Path to output directory.

project

my $project

Path to project directory.

opts

my %opts

Options given to the script

Functions

Usage

sub Usage

Prints usage.

GenDoc

sub GenDoc

Generates Murge documentation directory.

my $naturaldocs
Path to root of murge sources.
my $dirsrc
Path to root of murge sources.
my $dirnd
Path to directory containing images.
my $output
Path to output directory.
my $project
Path to project directory.
my %opts
Options given to the script
sub Usage
Prints usage.
sub GenDoc
Generates Murge documentation directory.
Close