Parameters

You can use annotation tags to document the parameters of composite operators, SPL functions, and native functions.

This tag is not supported in operator models.

@param <name> <description>
Documents the parameter of a composite operator, SPL function, or native function. You can describe each of the parameters by adding an @param tag to the SPLDOC for the composite or function. If a tag is not added for a specific parameter, the documentation generator includes the parameter without a description.
The following example shows the portion of SPLDOC that contains the port and parameter markup tags.
/**
....
@input Orders 
@output Revenue snapshot of aggregate revenue for food orders
@param snapshotPeriod period (in seconds) for computing revenue snaphot.
 
*/
composite ParallelAggregator(output Revenue; input Orders) {
	param
	  // Period for computing revenue snapshots.  
	  expression<int32> $snapshotPeriod;
  graph ...

The spl-make-doc command generates documentation.


An image of the generated documentation for parameters.