Generating ApamaDoc in headless mode

Headless mode lets you generate ApamaDoc from a command line as a standalone operation on Windows platforms. This is useful if you want to control what ApamaDoc generates without user-interface intervention, for example, when you are running nightly build integrations. Also, from the command line, you can control which files are exported and which files are omitted.

To generate ApamaDoc in headless mode, run the apamadoc.bat script, which is in the %APAMA_HOME%\bin folder. The apamadoc.bat file uses the %APAMA_HOME%\utilities\apamadoc.xml ant script to generate ApamaDoc.

-v	Optional. Displays verbose output on stdout about the process that is generating ApamaDoc.
output_folder	Identifies the folder that will contain the generated ApamaDoc.
monitor_file_base_folder	Specifies a folder that contains EPL .mon files for which you want to generate ApamaDoc. You can specify zero, one, or more folders. Insert a space between names. The apamadoc utility recursively processes specified folders.
monitor_file_path	Specifies an EPL .mon file for which you want to generate ApamaDoc. You can specify zero, one, or more .mon files. Insert a space between names.
file_path	File that lists the EPL source files for which you want to generate ApamaDoc. Specify this file by prepending an @ sign at the beginning of the path, for example, @C:\docfiles\inputEPLFilePaths.txt. In the specified file, specify one source file on each line. You cannot specify @location in the specified file; that is, this facility is not recursive.
-h	Optional. Specify -h to display usage information.

Note: The apamadoc utility requires Apache Ant. If you are not running the apamadoc utility from an Apama command prompt, you must ensure that the PATH variable for the headless ApamaDoc command line contains an entry for the Ant installation bin folder, for example, C:\ant_1.7.6\bin. This makes the Apama ant.bat file accessible to ApamaDoc generation.

On the command line, you can mix file paths, monitor file paths, and folder paths in any combination. The following example generates ApamaDoc for all monitor files in the C:\mon_files_dir folder as well as for the C:\Apama_monfiles/MyMonitor.mon file and all the files listed in the inputEPLFilePaths.txt file. The mon_files_dir folder is processed recursively. The generated ApamaDoc is put into the C:\generated_apamadocs folder.

The next example generates ApamaDoc and puts it in the C:\MyApplication\ApamaDoc folder. Specification of the -v option displays names of the files being processed on the command line. The files being processed are listed in the EPLsource.txt file.