Generating ApamaDoc from the command line
The apamadoc tool generates HTML documentation in ApamaDoc format from EPL files (.mon files).
The executable for this tool is located in the
bin directory of the Apama installation. Running the tool in the Apama Command Prompt or using the
apama_env wrapper (see
Setting up the environment using the Apama Command Prompt) ensures that the environment variables are set correctly.
Synopsis
To generate HTML documentation from EPL files using the apamadoc tool, run the following command:
apamadoc [options] output_folder input...
When you run this command with the --help option, the usage message for this command is shown.
Description
The apamadoc tool generates the HTML documentation in the specified output folder, using the input method described below.
You can view the ApamaDoc by opening output_folder/index.html in a web browser.
Options
The apamadoc tool takes the following options:
Option | Description |
-t title | Uses the specified title in the generated documentation. |
-p | Generates documentation for elements marked as private. |
-v | Generates verbose output on standard output. |
--includeMonitorMembers | Generates documentation for monitor members. By default, ApamaDoc is only generated for the API exposed by the specified EPL files. The members of monitors are therefore not generated (for example, inner events, variables and constants, fields in events, and actions). |
--help | -help | -h | Displays usage information. |
Operands
The apamadoc tool takes the following operands:
Operand | Description |
output_folder | The name of the folder in which the documentation is to be generated. |
input | The input method. Specify one or more of the following (you can specify any combination of these):  A file containing a list of EPL files, separated by newlines. The filename must be preceded by an ampersand (@). For example, @epl_list.txt. A folder that is recursively searched for the EPL files. An EPL file. If the same EPL file occurs more than once in the input, this file is only processed once. If an input file or folder is not found, the apamadoc tool reports an error. Documentation is not generated in this case. |
Examples
The following examples show the different ways in which the apamadoc tool can be started:
Generate documentation in the
doc folder, using the EPL files listed in the
epl_list.txt file:
apamadoc doc @epl_list.txt
Generate documentation as above, but with
Example as the title in the generated documentation:
apamadoc -t "Example" doc @epl_list.txt
Generate documentation in the
doc folder, recursively processing the EPL files in the
src/epl folder with verbose output enabled:
apamadoc -v doc src/epl
Generate documentation in the
doc folder from the
src/epl/example.mon file only:
apamadoc doc src/epl/example.mon
Generate documentation in the
doc folder, using the following: the EPL files listed in the
epl_list.txt file, the EPL files recursively found in the
src/epl folder, and the
myepl.mon file from the parent folder:
apamadoc doc @epl_list.txt src/epl ../myepl.mon
.