IBM InfoSphere Streams Version 4.1.1

Annotation tags

You can use the SPLDOC annotation tags to document the interfaces that are exposed by the SPL composite operators and to exclude toolkit artifacts. You can also use SPLDOC annotation tags to document SPL and native functions.

The format of SPLDOC annotation tags is represented in the following example:

@<tag name> <value> <content>

The @ character must be the first non-whitespace character in the line. If the @ character is not the first non-whitespace character, the spl-make-doc command treats the tag as text. The annotation tag terminates at the start of the next tag, or at the end of the SPLDOC comment block.

The value and content can be on separate lines. In SPL functions, paragraphs or code blocks in the tag contents are combined into a single paragraph. In native functions, the content is output on separate lines.

The spl-make-doc command recognizes a specific set of tag names. Each of these tags generates output in the generated documents. The document generator skips the tags that are not recognized by the spl-make-doc command. However, the skipped tags are captured, and can be used to annotate SPL artifacts by tools such as IBM® InfoSphere® Streams Studio.