Inserting ApamaDoc comments
To augment the documentation automatically generated by ApamaDoc, insert comments in your EPL files in the following format:
1. Start the comment with the /** characters, rather than the usual /* notation.
2. Enter the text you want to appear in the generated documentation.
3. After each newline, to continue the ApamaDoc comment, insert a * character at the beginning of the next line.
4. As needed, insert one or more tags for particular constructs. See Inserting ApamaDoc tags. Any tags must occur at the beginning of a newline (ignoring * and whitespace characters). Documentation for a tag ends when you declare another tag or end the comment. 5. End the comment with the usual */ characters.
For example, your EPL code might look like this:
/**
* Called by the monitor when it executes the onload() action.
* This action maintains the configuration for this scenario.
* @param sId The scenario ID.
* @param updateCallback The callback after the configuration is updated.
*/
action init(string sId, action<> updateCallback) {
scenarioId:=sId;
route GetConfiguration(scenarioId);
Configuration c;
listener l:=on Configuration(scenarioId=scenarioId):c {
config := c.configuration;
defaultConfig := c.defaults;
configurationUpdated();
updateCallback();
}
listeners.append(l);
}
When ApamaDoc processes these comments, it removes initial and trailing whitespace and * characters. For example, the ApamaDoc output would look like this:
init
void init(string sId, action< > updateCallback)
Called by the monitor during execution of the onload() action. This action
maintains the configuration for this scenario.
Parameters:
sId - The scenario ID.
updateCallback - The callback after the configuration is updated.
Listens:
com.apama.scenario.Configuration
Contact Support
|
Community
|
Feedback