Language reference : Technical content architecture : Domain elements : Programming elements : parml
   
parml
The parameter list (<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.
Contains
Note: These models represent only the default document types distributed by OASIS. Actual content models will differ with each new document type.
Doctype
Content model
topic (technical content), map (technical content), concept, ditabase, glossary, glossentry, glossgroup, reference, task, bookmap
(plentry) (one or more)
Contained by
Doctype
Content model
topic (technical content)
map (technical content), bookmap
concept
ditabase
glossary, glossentry, glossgroup
reference
task (strict), task (general)
Inheritance
+ topic/dl pr-d/parml
Example 358. 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
Name
Description
Data Type
Default Value
Required?
compact
Indicates close vertical spacing between the list items. Expanded spacing is the default value. The output result of compact spacing depends on the processor or browser. Allowed values are:
yes
Indicates compact spacing.
no
Indicates expanded spacing.
-dita-use-​conref-​target
See Using the -dita-use-conref-target value for more information.
 
(yes | no | -dita-use-​conref-​target)
#IMPLIED
No
spectitle
The specialized title attribute allows architects of specialized types to define a fixed or default title for a specialized element. Not intended for direct use by authors.
CDATA
#IMPLIED
No
univ-atts attribute group (includes select-atts, id-atts, and localization-atts groups)
A set of related attributes, described in univ-atts attribute group
global-atts attribute group (xtrf, xtrc)
A set of related attributes, described in global-atts attribute group
class, outputclass
Common attributes described in Other common DITA attributes