Programming domain
The elements in the programming domain are designed for documenting programming languages.
Programming domain elements
The elements in the programming domain each have a specific semantic purpose.
| Element Name | Semantic Purpose |
|---|---|
| apiname | API name |
| codeblock | code block |
| codeph | code phrase |
| option | one of a set of options |
| parmname | parameter or argument |
| parml | parameter list |
| plentry | parameter list entry (within parml) |
| pt | parameter term (within plentry) |
| pd | parameter definition (within plentry) |
| synph | syntax phrase |
| syntaxdiagram | syntax diagram |
| groupseq | group of syntactic units (used only for syntax diagrams) |
| groupchoice | choice of a group of syntactic units (used only for syntax diagrams) |
| groupcomp | group of composite syntactic units (used only for syntax diagrams) |
| fragment | fragment of syntax (used only for syntax diagrams) |
| fragref | cross-reference to a fragment of syntax |
| synblk | block of small pieces of syntax |
| synnote | footnote within syntax (syntax note) |
| synnoteref | cross-reference to a syntax note |
| kwd | syntax keyword (used only for syntax diagrams) |
| var | variable that a user must supply (used only for syntax diagrams) |
| oper | operator character (such as +, -, and =) within syntax |
| delim | delimiter character (such as /, |, and ;) within syntax |
| sep | separator character within syntax |
| repsep | separator character for repeated syntax elements |