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.
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>
returnType methodName(pList1, pList2) {where
Doctype | Content model |
---|---|
ditabase, topic, task, reference, concept, glossary | ( plentry) (one or more) |
+ topic/dl pr-d/parml
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 | 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; (%select-atts;, %id-atts;, %localization-atts;) | A set of related attributes, described at %univ-atts; | parameter entity | PE not applicable | Not applicable |
%global-atts; (xtrf, xtrc) | A set of related attributes, described at %global-atts; | parameter entity | PE not applicable | Not applicable |
class, outputclass | Common attributes described in Other common DITA attributes |
Return to main page.
OASIS DITA Language Specification v1.1 -- Committee Draft 02, 8 May 2007
Copyright © OASIS Open 2005, 2007. All Rights Reserved.