Code constructs that are documented
The ApamaDoc generates documentation for the following code constructs:
Monitors
Events (defined outside monitors)
Fields, constants and actions on events
Custom aggregate functions
Fields, constants and actions on custom aggregate functions
Plug-in import statements
By default, the ApamaDoc export wizard does not generate documentation for inner fields or events of a monitor. If you want to include inner fields and events of a monitor, generate ApamaDoc without a user interface using the
--includeMonitorMembers option. See
Generating ApamaDoc from the command line or
Generating ApamaDoc from an Ant script for more information.
To find out how ApamaDoc can be useful for documenting the storage and flow of personal data within your application, see
Documenting personal data flows within an Apama application.