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 NameSemantic Purpose
apinameAPI name
codeblockcode block
codephcode phrase
option one of a set of options
parmnameparameter or argument
parmlparameter list
plentryparameter list entry (within parml)
ptparameter term (within plentry)
pdparameter definition (within plentry)
synphsyntax phrase
syntaxdiagramsyntax diagram
groupseqgroup of syntactic units (used only for syntax diagrams)
groupchoicechoice of a group of syntactic units (used only for syntax diagrams)
groupcompgroup of composite syntactic units (used only for syntax diagrams)
fragmentfragment of syntax (used only for syntax diagrams)
fragrefcross-reference to a fragment of syntax
synblkblock of small pieces of syntax
synnotefootnote within syntax (syntax note)
synnoterefcross-reference to a syntax note
kwdsyntax keyword (used only for syntax diagrams)
varvariable that a user must supply (used only for syntax diagrams)
operoperator character (such as +, -, and =) within syntax
delimdelimiter character (such as /, |, and ;) within syntax
sepseparator character within syntax
repsepseparator character for repeated syntax elements