Command-line options
The usual way to invoke gedoc is as follows:
gedoc --format=<output_format> --output=<output_directory> <input_filename>
This will read the description of your Eiffel project from the Xace or
ECF file
input_filename, analyze it, and generate
the documentation files in directory
output_directory
using the format
output_format. Note that in addition
to Xace and ECF, the file
input_filename can also
be an Eiffel class file. In that case, your Eiffel project will be considered
to be made up of only one Eiffel class. This is useful when we just want to
pretty-print one Eiffel file.
Here is the list of options that can be used with gedoc:
-
-h
-
--help
-
Print a summary of the command-line options of gedoc and exit.
-
--format=<pretty_print|html_ise_stylesheet>
-
Format for the output. (default: pretty_print) The formats currently supported are
pretty_print to use gedoc as an
Eiffel pretty-printer, and
html_ise_stylesheet to generate
HTML documentation using
ISE's stylesheet.
-
-c <class_name>
-
--class=<class_name>
-
Name of classes to be processed. (default: process all classes
in the Eiffel project) The name can contain wildcards such as
FOO* or @(FOO|BAR).
This option can be used several times to specify several class
names.
-
-o <directory_name>
-
--output=<directory_name>
-
Directory for generated files. (default: next to each class file)
-
--library-prefix
-
Add subfolders with library names in the output directory.
-
-f
-
--force
-
Overwrite existing files without asking.
-
-i
-
--interactive
-
Ask before overwriting a file, unless --force is specified.
-
--ise[=major[.minor[.revision[.build]]]]
-
Version of Eiffel whose semantics should be used during code analysis. (default: latest version)
-
--define=NAME=VALUE
-
Define variables to be used when reading Xace files. This option can be used several
times to define several variables.
-
--silent
-
Run gedoc in silent mode.
-
--verbose
-
Run gedoc in verbose mode.
-
-V
-
--version
-
Print the version number of gedoc and exit.