DITA 1.3 Language Reference : Language reference: All-inclusive edition : Technical content elements : Technical-content domains elements : Programming elements : parml
Was this helpful?
parml
The parml element contains a list of terms and definitions that describes the parameters in an application programming interface. This is a special kind of definition list that is designed for documenting programming parameters. This element is part of the DITA programming domain, a special set of DITA elements designed to document programming tasks, concepts, and reference information.
Content models
See appendix for information about this element in OASIS document type shells.
Inheritance
+ topic/dl pr-d/parml
Example 382. Example
Example source:
This code example is a basic method signature:
<codeblock>returnType methodName(pList1, pList2) {</codeblock>
where
<parml>
<plentry>
<pt>pList1</pt>
<pd>is the first variable declaration passed to methodName</pd>
</plentry>
<plentry>
<pt>pList2</pt>
<pd>is the second variable declaration passed to methodName</pd>
</plentry>
</parml>
Example output:
This code example is a basic method signature:
returnType methodName(pList1, pList2) {
where
pList1
is the first variable declaration passed to methodName
pList2
is the second variable declaration passed to methodName
Attributes
The following attributes are available on this element: Universal attribute group, compact, outputclass, and spectitle.