metaonly module xdc.tools.cdoc.Main
index URL

Command implementation

cdoc is a package documentation generation utility. It builds a directory of browsable HTML documentation using the meta- information stored in RTSC packages. [ more ... ]
XDCscript usage meta-domain sourced in xdc/tools/cdoc/Main.xdc
var Main = xdc.useModule('xdc.tools.cdoc.Main');
module-wide config parameters
    Main.usage// Usage for this command = String[] [
        '[-od:dir] [-title text] [--start package] [--indexonly] [--doxytags file] [--doxybase dir] [-h] [-n] [-b] [-s] [-P pkg-dir...|-Pr repo-dir...|-A]'
    ];
module-wide functions
    Main.exec// 'xs' script entry point(Any args) returns Any
    Main.main// 'xs' shell entry point(Any args) returns Any
per-instance config parameters
    var params = new Main.Params// Instance config-params object;
        params.aopt// Generate documentation for all packages on the package path = Bool false;
        params.bopt// Generate a single "big" output = Bool false;
        params.doxybase// The directory containing doxygen html files = String null;
        params.doxytags// Process doxygen links, using this argument as the tag file = String null;
        params.hopt// Generate html pages only, not table of contents or index = Bool false;
        params.iopt// Generate index and table of contents only = Bool false;
        params.language// Language to document. Deprecated = String null;
        params.lopt// Don't include dependent packages. Deprecated = Bool false;
        params.nopt// Generate nodoc'd docs = Bool false;
        params.outdir// Place the generated files in the named directory = String null;
        params.popt// The subsequent directories are package directories = Bool false;
        params.qopt// Quiet mode = Bool false;
        params.ropt// The subsequent directories are repositories of packages = Bool false;
        params.sopt// Include .xdc file sources = Bool false;
        params.start// Set start page to specified package = String null;
        params.style// Use specified style sheet = String null;
        params.title// Generated HTML pages will show the string in the page title = String null;
per-instance functions
    inst.run// Underlying implementation(Cmdr.Instance cmdr, String[] args) returns Any
 
DETAILS
cdoc is a package documentation generation utility. It builds a directory of browsable HTML documentation using the meta- information stored in RTSC packages.
This utility is invoked via the XDCtools xs command. In the examples below we assume that the alias cdoc is defined as follows:
      $(XDCROOT)/xs xdc.tools.cdoc
where $(XDCROOT) is the installation directory of the XDCtools toolset.
EXAMPLES
In the examples below we assume that the alias cdoc is defined as $(XDCROOT)/xs xdc.tools.cdoc, where $(XDCROOT) is the installation directory of the XDCtools toolset.
1. To generate documentation for the package in the current working directory:
      cdoc
Since no package is specified and no output directory is specified, documentation is generated for the package in the current working directory and the output is placed in the package's ./package/cdoc sub-directory.
2. To generate documentation with the title "My Packages" for all packages installed in the myPackages repository:
      cdoc -title "My Packages" -Pr myPackages
Since no output directory was specified and documentation will be for more than one package, the generated files are placed in the directory ./cdoc.
3. To generate documentation for the package located in ./ti/bios and put results in the directory ./html.
      cdoc -od:html -P ti/bios
NOTE
cdoc processes the XML files that are generated *after* a package is built (actually after the .interfaces goal is built). One must first build a package before generating its documentation. If you change a .xdc file and re-run cdoc without rebuilding the package, the change in the .xdc file will not show up in the generated docs.
When interatively updating a package's .xdc files and examining the generated documentation, it is useful to define a command alias that first "compiles" the package's .xdc files and then runs the cdoc tool. For example, if your shell is Korn shell compatible, the following command alias ensures that any changes in .xdc files will show up in the generated documents:
      function cdoc {
          $XDCROOT/xdc .interfaces
          $XDCROOT/xs xdc.tools.cdoc $*
      }
config Main.usage  // module-wide
index URL

Usage for this command

XDCscript usage meta-domain
Main.usage = String[] [
    '[-od:dir] [-title text] [--start package] [--indexonly] [--doxytags file] [--doxybase dir] [-h] [-n] [-b] [-s] [-P pkg-dir...|-Pr repo-dir...|-A]'
];
Main.exec()  // module-wide
index URL

'xs' script entry point

XDCscript usage meta-domain
Main.exec(Any args) returns Any
Main.main()  // module-wide
index URL

'xs' shell entry point

XDCscript usage meta-domain
Main.main(Any args) returns Any
Instance Config Parameters
index URL

XDCscript usage meta-domain
var params = new Main.Params;
// Instance config-params object
    params.aopt = Bool false;
    // Generate documentation for all packages on the package path
    params.bopt = Bool false;
    // Generate a single "big" output
    params.doxybase = String null;
    // The directory containing doxygen html files
    params.doxytags = String null;
    // Process doxygen links, using this argument as the tag file
    params.hopt = Bool false;
    // Generate html pages only, not table of contents or index
    params.iopt = Bool false;
    // Generate index and table of contents only
    params.language = String null;
    // Language to document. Deprecated
    params.lopt = Bool false;
    // Don't include dependent packages. Deprecated
    params.nopt = Bool false;
    // Generate nodoc'd docs
    params.outdir = String null;
    // Place the generated files in the named directory
    params.popt = Bool false;
    // The subsequent directories are package directories
    params.qopt = Bool false;
    // Quiet mode
    params.ropt = Bool false;
    // The subsequent directories are repositories of packages
    params.sopt = Bool false;
    // Include .xdc file sources
    params.start = String null;
    // Set start page to specified package
    params.style = String null;
    // Use specified style sheet
    params.title = String null;
    // Generated HTML pages will show the string in the page title
config Main.aopt  // instance
index URL

Generate documentation for all packages on the package path

XDCscript usage meta-domain
var params = new Main.Params;
  ...
params.aopt = Bool false;
config Main.bopt  // instance
index URL

Generate a single "big" output

XDCscript usage meta-domain
var params = new Main.Params;
  ...
params.bopt = Bool false;
config Main.doxybase  // instance
index URL

The directory containing doxygen html files

XDCscript usage meta-domain
var params = new Main.Params;
  ...
params.doxybase = String null;
config Main.doxytags  // instance
index URL

Process doxygen links, using this argument as the tag file

XDCscript usage meta-domain
var params = new Main.Params;
  ...
params.doxytags = String null;
config Main.hopt  // instance
index URL

Generate html pages only, not table of contents or index

XDCscript usage meta-domain
var params = new Main.Params;
  ...
params.hopt = Bool false;
config Main.iopt  // instance
index URL

Generate index and table of contents only

XDCscript usage meta-domain
var params = new Main.Params;
  ...
params.iopt = Bool false;
config Main.language  // instance
index URL

Language to document. Deprecated

XDCscript usage meta-domain
var params = new Main.Params;
  ...
params.language = String null;
config Main.lopt  // instance
index URL

Don't include dependent packages. Deprecated

XDCscript usage meta-domain
var params = new Main.Params;
  ...
params.lopt = Bool false;
config Main.nopt  // instance
index URL

Generate nodoc'd docs

XDCscript usage meta-domain
var params = new Main.Params;
  ...
params.nopt = Bool false;
config Main.outdir  // instance
index URL

Place the generated files in the named directory

XDCscript usage meta-domain
var params = new Main.Params;
  ...
params.outdir = String null;
config Main.popt  // instance
index URL

The subsequent directories are package directories

XDCscript usage meta-domain
var params = new Main.Params;
  ...
params.popt = Bool false;
DETAILS
Generates documentation for each of the specified packages.
config Main.qopt  // instance
index URL

Quiet mode

XDCscript usage meta-domain
var params = new Main.Params;
  ...
params.qopt = Bool false;
config Main.ropt  // instance
index URL

The subsequent directories are repositories of packages

XDCscript usage meta-domain
var params = new Main.Params;
  ...
params.ropt = Bool false;
DETAILS
Generates documentation for all packages rooted in each of the specified repositories.
config Main.sopt  // instance
index URL

Include .xdc file sources

XDCscript usage meta-domain
var params = new Main.Params;
  ...
params.sopt = Bool false;
DETAILS
In the generated documentation for each .xdc file, link to a pretty-printed view of the .xdc file source text.
config Main.start  // instance
index URL

Set start page to specified package

XDCscript usage meta-domain
var params = new Main.Params;
  ...
params.start = String null;
DETAILS
The opening page is, by default, the documentation for the alphabetically first package processed. This option allows you to explicitly specify the package used.
If "" is specified, the start page will be blank.
If the package specified is not processed, no warning or error results; it is assumed that when the documentation is used the specified package documentation will exist.
config Main.style  // instance
index URL

Use specified style sheet

XDCscript usage meta-domain
var params = new Main.Params;
  ...
params.style = String null;
config Main.title  // instance
index URL

Generated HTML pages will show the string in the page title

XDCscript usage meta-domain
var params = new Main.Params;
  ...
params.title = String null;
Main.run()  // instance
index URL

Underlying implementation

XDCscript usage meta-domain
inst.run(Cmdr.Instance cmdr, String[] args) returns Any
generated on Tue, 24 Aug 2010 15:39:20 GMT