EDoc: Use

previous next

Basic Use

EDoc usage: edoc [-s] {path_to_include_file}

-s: Don't show output (silent)
path_to_include_file: Path to either an xace or an options file

System Documentation

To generate the documentation of a system (i.e. an xace file of a system) switch to the installation directory and launch 'edoc path/to/your/system.xace'. This will use default options and put the generated documentation in the directory output.

If you want more control how the output looks you should use an options file where you can specify various output options.

Library Documentation

To generate the documentation of a library (i.e. an xace file of a library) switch to the installation directory and launch 'edoc path/to/your/library.xace'. This will use default options and put the generated documentation in the directory output.

Note: the xace file has to be named 'library.xace'! Otherwise it is assumed that the xace specifies a system.

If you want more control how the output looks you should use an options file where you can specify various output options.

Documentation from an Options file

To generate the documentation according to an options input file, switch to the installation directory and launch 'edoc path/to/your/options_file'. This will use the options specified in the file including the output directory.

If you have an options file which you use often, you can place it in the options directory and give it the name '{your_name}.options'. Then you can simply type 'edoc {your_name}' and the appropriate file will be selected.

Documentation for Clusters

EDoc provides the possibility to set a documentation per cluster. This is achieved by putting a file in the cluster directory which is named one of:

The '.txt' files will be used as a whole while in the '.html' files only the part in the body tag will be used.


Copyright © 2005, Julian Tschannen
mailto:juliant@student.ethz.ch
Last Updated: 30 Oktober 2005
index previous next