Ports

You can use annotation tags to specify the input and output ports of a composite operator.

The input port and output port tags are supported in SPL files only. These tags are not supported for primitive operators. The port and other tags can be positioned in any order.

@input <port name> <description>
Denotes an input port for a composite operator. The generated documentation includes this input port only if the corresponding composite is defined with a port of the same name. If an input port is not annotated in the SPLDOC for the composite, the generated document includes the input port without a description.
@output <port name> <description>
Denotes an output port for a composite operator. The generated documentation includes this output port only if the corresponding composite is defined with a port of the same name. If an output port is not annotated in the SPLDOC for the composite, the generated document includes the output port without a description.
The following example shows extracted code from the SPLDOC documentation of a composite operator port.
/** 
...
@input Orders Customer orders 
@output Revenue Revenue from orders
...
*/
composite ParallelAggregator(output Revenue; input Orders) { ...

The spl-make-doc command generates documentation.


An image of the generated documentation for the composite operator ports.