Login or Register to Ask a Question and Join Our Community

Linux and UNIX Man Pages

Linux & Unix Commands - Search Man Pages

naturaldocs(1) [debian man page]

NATURALDOCS(1)						      General Commands Manual						    NATURALDOCS(1)

NAME

       NaturalDocs - an extensible, multi-language documentation generator

SYNOPSIS

       naturaldocs -i <input (source) directory> [-i <input (source) directory> ...] -o <output format> <output directory> [-o <output format>
       <output directory> ...] -p <project directory> [options]

DESCRIPTION

       This manual page documents briefly the .B naturaldocs command. Note that naturaldocs is a wrapper script that on Debian	invokes  the  real
       NaturalDocs perl program. So, the real, original name of the program is NaturalDocs but on Debian systems you invoke it as naturaldocs.

       Natural	Docs  is  is  an  open-source, extensible, multi-language documentation generator. You document your code in a natural syntax that
       reads like plain English. Natural Docs then scans your code and builds high-quality HTML documentation from it.

OPTIONS

       A summary of options, extracted from the help printed by the -h switch is included below.  For a complete description  of  how  NaturalDocs
       works, see the text files in the /usr/share/doc/naturaldocs directory.

       Required parameters:

       -i, --input, --source DIR
	      Specifies an input (source) directory. Required.
	      Can be specified multiple times.

       -o, --output FMT DIR
	      Specifies an output format and directory. Required.
	      Can be specified multiple times, but only once per directory. Possible output formats are HTML and FramedHTML.

       -p, --project DIR
	      Specifies the project directory. Required.
	      There needs to be a unique project directory for every source directory.

       Optional parameters:

       -s, --style STYLE [STYLE ...]
	      Specifies the CSS style when building HTML output. If multiple styles are specified, they will all be included in the order given.

       -img, --image DIR
	      Specifies an image directory. Can be specified multiple times. Start with * to specify a relative directory, as in -img */images.

       -do, --documented-only
	      Specifies only documented code aspects should be included in the output.

       -t, --tab-length LEN
	      Specifies  the  number of spaces tabs should be expanded to. This only needs to be set if you use tabs in example code and text dia-
	      grams. Defaults to 4.

       -xi, --exclude-input, --exclude-source
	      Excludes an input (source) directory from the documentation. Automatically done for the project and output directories. Can be spec-
	      ified multiple times.

       -nag, --no-auto-group
	      Turns off auto-grouping completely.

       -oft, --only-file-titles
	      Source files will only use the file name as the title.

       -r, --rebuild
	      Rebuilds all output and data files from scratch. Does not affect the menu file.

       -ro, --rebuild-output
	      Rebuilds all output files from scratch.

       -q, --quiet
	      Suppresses all non-error output.

       -?, -h, --help
	      Displays syntax reference.

AUTHOR

       NaturalDocs was written by Greg Valure <gregvalure@naturaldocs.org>.

       This manual page was written by Federico Di Gregorio <fog@debian.org>, for the Debian project (but may be used by others).

								     May 2007							    NATURALDOCS(1)

Check Out this Related Man Page

JSDOC-TOOLKIT(1)					     jsdoc-toolkit User Manual						  JSDOC-TOOLKIT(1)

NAME

       jsdoc - automatic generator for HTML documentation of Javascript sources

SYNOPSIS

       jsdoc {-d=<PATH> | --directory=<PATH>}  [options] <SRC_DIR_OR_FILE> ...

       jsdoc [{-h | --help}]

DESCRIPTION

       This manual page documents briefly the jsdoc command.

       jsdoc is application, written in JavaScript, for automatically generating template-formatted, multi-page HTML (or XML, JSON, or any other
       text-based) documentation from commented JavaScript source code.

OPTIONS

       The program follows the usual GNU command line syntax, with long options starting with two dashes (`-'). A summary of options is included
       below. For a complete description, see the info(1) files.

       -a, --allfunction
	   Include all functions, even undocumented ones.

       -c, --conf
	   Load a configuration file.

       -d=<PATH>, --directory=<PATH>
	   Output to this directory (required parameter).

       -D="myVar:My value", --define="myVar:My value"
	   Multiple. Define a variable, available in JsDoc as JSDOC.opt.D.myVar.

       -e=<ENCODING>, --encoding=<ENCODING>
	   Use this encoding to read and write files.

       -E="REGEX", --exclude="REGEX"
	   Multiple. Exclude files based on the supplied regex.

       -h, --help
	   Show this message and exit.

       -m, --multiples
	   Don't warn about symbols being documented more than once.

       -n, --nocode
	   Ignore all code, only document comments with @name tags.

       -o=<PATH>, --out=<PATH>
	   Print log messages to a file (defaults to stdout).

       -p, --private
	   Include symbols tagged as private, underscored and inner symbols.

       -q, --quiet
	   Do not output any messages, not even warnings.

       -r=<DEPTH>, --recurse=<DEPTH>
	   Descend into src directories.

       -s, --suppress
	   Suppress source code output.

       -S, --securemodules
	   Use Secure Modules mode to parse source code.

       -t=<PATH>, --template=<PATH>
	   Use this template to format the output.

       -T, --test
	   Run all unit tests and exit.

       -u, --unique
	   Force file names to be unique, but not based on symbol names.

       -v, --verbose
	   Provide verbose feedback about what is happening.

       -x=<EXT>[,EXT]..., --ext=<EXT>[,EXT]...
	   Scan source files with the given extension/s (defaults to js).

BUGS

       The following bugs are known bugs:

       Does not support spaces in arguments
	   The wrapper jsdoc is not immune to spaces in filenames, either escaped or not.

AUTHOR

       Georges Khaznadar <georgesk@ofset.org>
	   Wrote this manpage for the Debian system.

COPYRIGHT

       Copyright (C) 2011 Georges Khaznadar

       This manual page was written for the Debian system (and may be used by others).

       Permission is granted to copy, distribute and/or modify this document under the terms of the GNU General Public License, Version 2 or (at
       your option) any later version published by the Free Software Foundation.

       On Debian systems, the complete text of the GNU General Public License can be found in /usr/share/common-licenses/GPL-2.

jsdoc-toolkit							    07/16/2011							  JSDOC-TOOLKIT(1)
Man Page