IBM InfoSphere Streams Version 4.1.1

SPLDOC markup

You can use SPLDOC markup to associate comments with the SPL artifacts in a toolkit. The spl-make-doc command generates HTML documentation from the marked up artifacts.

Comments
This information describes the comment syntax for the SPL artifacts in SPL files. SPLDOC comments are delimited by the forward slash and asterisk characters.
Text markup
You can use SPLDOC markup to format text into pages, sections, paragraphs, lists, and blocks of code. You can also apply different typefaces, such as italics, bold, and monospace.
Escape
To suppress interpretation by the spl-make-doc command, precede the SPLDOC markup character by a backslash ( \ ), which is the escape character.
Links
You can use SPLDOC to mark up different kinds of links.
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.
Images
You can embed image files in the generated document by specifying the image file name and a label for the image.
Formatting conventions
By following the formatting conventions when you mark up the toolkit artifacts, you ensure that the spl-make-doc command interprets the markup correctly and generates the expected results.

Parent topic: Reference

Related reference:

Embedded documentation

spl-make-doc

Related information:

Toolkits