Login or Register to Ask a Question and Join Our Community

Linux and UNIX Man Pages

Linux & Unix Commands - Search Man Pages

jsdoc(1) [debian 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)

Check Out this Related Man Page

WXGLADE(1)							   User Commands							WXGLADE(1)

NAME

       wxglade - python program to build user interfaces based on the wxWidgets toolset.

SYNOPSIS

       wxglade [--help | -h]

       wxglade [--version]

       wxglade [FILENAME.wxg]

       wxglade {-g LANG | --generate-code LANG} [-o DESTINATION | --output DESTINATION] FILENAME.wxg

DESCRIPTION

       wxglade wxGlade is a GUI designer written in Python with the popular GUI toolkit wxPython, that helps you create wxWidgets/wxPython user
       interfaces. At the moment it can generate Python, Lisp, C++ and XRC (wxWidgets' XML resources) code.

OPTIONS

       These programs follow 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 files.

       -g or --generate-code LANG
	   If you only want to generate the code without starting the GUI, use the -g or --generate-code option with the language as argument

	   Possible values for LANG are "python", "lisp", "XRC", "perl" or "C++".

       -o or --output DESTINATION
	   You can specify the destination of the generated code with -o or --output option.

	   The DESTINATION argument can be a file or a directory. It is a file when the FILENAME.wxg generates single-file source code. It is a
	   directory when the FILENAME.wxg generates multiple-file source code.

       -h or --help
	   Show the help message and exit

       --version
	   Show programs version number and exit

EXAMPLES

       Generate Python code out of myapp.wxg:

       wxglade -o /tmp -g python myapp.wxg

       Open file myapp.wxg in wxGlade GUI:

       wxglade myapp.wxg

BUGS

       Report wxGlade bugs to <wxglade-general@lists.sourceforge.net> or <http://sourceforge.net/projects/wxglade/>

SEE ALSO

       wxGlade home page <http://wxgalde.sourceforge.net>

AUTHORS

       Georges Khaznadar <georgesk@ofset.org>
	   This manual page was originally written by Georges Khaznadar for the Debian(TM) system (but 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 any later version
	   published by the Free Software Foundation. On Debian(TM) systems, the complete text of the GNU General Public License can be found in
	   /usr/share/common-licenses/GPL.

       Carsten Grohmann <mail@carstengrohmann.de>
	   Update and extend manual page

COPYRIGHT

       Copyright (C) 2003, 2012 Georges Khaznadar, Carsten Grohmann

wxGlade 							 January 07, 2012							WXGLADE(1)
Man Page