COBERTURA-REPORT(1) General Commands Manual COBERTURA-REPORT(1)NAME
cobertura-report -- generate coverage reports
SYNOPSIS
cobertura-report [--datafile file] --destination dir [--format html|xml] [--encoding encoding] directory [--basedir dir]
DESCRIPTION
cobertura-report generates coverage reports from the source code directories and calculates the cyclomatic code complexity of each class.
The HTML reports are also made of annotated versions of each source file, showing which lines of code were excercised.
OPTIONS --datafile file
Specify the name of the file containing metadata about your classes. Default value: "./cobertura.ser".
--basedir dir
Specify a directory containing source code. All files listed after this are assumed to be underneath this directory. This should
only be used if you want to include only a few specific files underneath a source tree and exclude all other files.
--destination dir
Specify the output directory for the report.
--format xml|html
The type of report you want to generate. Default value: html.
--encoding encoding
Specify the encoding used to read the source. See javadocs for java.nio.charset.Charset for more details.
SEE ALSO junit(1), cobertura-instrument(1), cobertura-check(1), cobertura-merge(1).
AUTHOR
This manual page was written by Miguel Landaeta <miguel@miguel.cc> for the Debian system (but may be used by others). Permission is
granted to copy, distribute and/or modify this document under the terms of the terms of GNU General Public License, Version 2 or 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.
COBERTURA-REPORT(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)