Quick reference for SPLDOC markup

SPLDOC markup tags document SPL artifacts in a toolkit.

For information about the conventions for using SPLDOC markup, see Formatting conventions.

Table 1. SPLDOC markup tags

Use the information in the table to quickly look up the SPLDOC markup tags.
Tag name Markup tag Example Output Learn more
Annotation - input ports (SPL composite operators only) @input <port name> <description> @input Orders customer orders Input ports:

Orders - customer orders

 Ports
Annotation - output ports (SPL composite operators only) @output <port name> <description> @output Revenue revenue from orders Output ports:

Revenue - revenue from orders
Annotation - parameters (SPL composite operators and SPL functions only) @param <parameter name> <descriptions @param snapshotPeriod period (in seconds) for computing revenue snapshot Parameters: snapshotPeriod - period (in seconds) for computing revenue snapshot Parameters
Annotation - return values (SPL functions only) @return <description> @return the message Returns - the message Return values
Annotation - exceptions @throws <exception-name> <description> @throws SPLRuntimeInvalidMetricException If the metric already exists. Throws:

SPLRuntimeInvalidMetricException - if the metric already exists

 Exceptions
Annotation - exclude toolkit artifacts @exclude @exclude Excludes - the artifact from the generated output Exclude artifacts
Annotation - samples (toolkits only) @sample <description> This toolkit contains samples showing how to use the myToolkit toolkit. @sample </description> Documentation that is similar to that of a main toolkit and that identifies the toolkit and its artifacts as providing samples Samples
Bold **

(surrounding double asterisks)

 This is **very important**. This is very important. Italics and bold typeface
Code block Indented by four or more spaces (relative to the indentation of the first line of the enclosing text, such as the first line of an SPLDOC comment, or the first list item in a list) 
    x=x+1;
    y=x;
 
    x=x+1;
    y=x;
 Code block
Comments in SPL files /**<comment text>*/

(delimited by forward slash and asterisks)

 
/**
This is a valid SPLDOC comment.
 */
 Comments
Escape \

(backslash)

 Parameter range: \[0...N\] Parameter range: [0...N] Escape
Image {<image file>|<alt text>} {../image/figure-1.jpg|Figure 1} An image that is labeled "Figure 1" Images
Italics *

(surrounding asterisks)

 This is *important*. This is important. Italics and bold typeface
Link to an SPL artifact [[<artifact type>:] [<namespace>::] <artifact name>[(parameter types)]|[<label>]] [operator:sample::LinuxPipe|LinuxPipe] A link that is labeled LinuxPipe to an anchor point corresponding to the operator in the SPLDOC document Links to SPL artifacts
Link to a function [[<artifact type>:] [<namespace>::] <artifact name>[(parameter types)]|[<label>]] [function:sample::getMaximum(int32,int32)|
getMaximum(int32,int32)]		 A link that is labeled getMaximum(int32,int32) to an anchor point corresponding to the function in the SPLDOC document Links to functions
Link for a URI [<URL>|<label>] [http://www.ibm.com|IBM] A link that is labeled Teracloud® to www.ibm.com URI links and labels
Monospace `

(surrounding back quotation marks)

 ` f(x)` is a function. f(x) is a function. Monospace typeface
Ordered list 1.

(positive numeric character followed by a period and a space)

 
1. First item
2. Second item
3. Third item
  1. First item
  2. Second item
  3. Third item
 Lists
Page + page title + Title for new page Title for new page (this link to the new page is followed by the first sentence from the new page, if any, and a new page is generated with the title and any further documentation) Page
Paragraph A blank line First paragraph

Second paragraph

 First paragraph

Second paragraph

 Paragraphs
Section # section title # New section within a page New section within a page Section
Tables --- 
-----------------
| R1 C1  | R1 C2 |  
|----------------|
| R2 C1  | R2 C2 |
-----------------
 A table with two columns and two rows. Tables
Unordered list *

(preceding single asterisk)

 
* First item
* Second item
  * Sub item
  • First item
  • Second item
    • Sub item
 Lists