###### 3.2.6.2.7 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

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) | desc, p, note, lq, li, itemgroup, dd, fig, figgroup, stentry, draft-comment, fn, entry, abstract, body, bodydiv, section, sectiondiv, example, linkinfo, pd
map (technical content), bookmap | desc, p, note, lq, li, itemgroup, dd, fig, figgroup, stentry, draft-comment, fn, entry, pd
concept | desc, p, note, lq, li, itemgroup, dd, fig, figgroup, stentry, draft-comment, fn, entry, abstract, body, bodydiv, section, sectiondiv, example, linkinfo, conbody, pd
ditabase | desc, p, note, lq, li, itemgroup, dd, fig, figgroup, stentry, draft-comment, fn, entry, abstract, body, bodydiv, section, sectiondiv, example, linkinfo, conbody, prereq, context, steps-informal, stepsection, info, tutorialinfo, stepxmp, choice, choptionhd, chdeschd, choption, chdesc, stepresult, result, postreq, refsyn, proptypehd, propvaluehd, propdeschd, propdesc, glossdef, glossUsage, glossScopeNote, pd
glossary, glossentry, glossgroup | desc, p, note, lq, li, itemgroup, dd, fig, figgroup, stentry, draft-comment, fn, entry, abstract, body, bodydiv, section, sectiondiv, example, linkinfo, conbody, glossdef, glossUsage, glossScopeNote, pd
reference | desc, p, note, lq, li, itemgroup, dd, fig, figgroup, stentry, draft-comment, fn, entry, abstract, body, bodydiv, section, sectiondiv, example, linkinfo, refsyn, proptypehd, propvaluehd, propdeschd, propdesc, pd
task (strict), task (general) | desc, p, note, lq, li, itemgroup, dd, fig, figgroup, stentry, draft-comment, fn, entry, abstract, body, bodydiv, section, sectiondiv, example, linkinfo, prereq, context, steps-informal, stepsection, info, tutorialinfo, stepxmp, choice, choptionhd, chdeschd, choption, chdesc, stepresult, result, postreq, pd

###### Inheritance

+ topic/dl pr-d/parml

###### 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. | (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 3.4.1.3 univ-atts attribute group |  |  |
global-atts attribute group (xtrf, xtrc) | A set of related attributes, described in 3.4.1.2 global-atts attribute group |  |  |
class, outputclass | Common attributes described in 3.4.1.9 Other common DITA attributes |  |  |

Previous Topic: 3.2.6.2.6 parmname

Next Topic: 3.2.6.2.8 plentry

Parent Topic: 3.2.6.2 Programming elements

Sibling Topics:

3.2.6.2.1 apiname

3.2.6.2.2 codeblock

3.2.6.2.3 coderef

3.2.6.2.4 codeph

3.2.6.2.5 option

3.2.6.2.6 parmname

3.2.6.2.8 plentry

3.2.6.2.9 pt

3.2.6.2.10 pd

3.2.6.2.11 synph

3.2.6.2.12 syntaxdiagram

3.2.6.2.13 groupseq

3.2.6.2.14 groupchoice

3.2.6.2.15 groupcomp

3.2.6.2.16 fragment

3.2.6.2.17 fragref

3.2.6.2.18 synblk

3.2.6.2.19 synnote

3.2.6.2.20 synnoteref

3.2.6.2.21 kwd

3.2.6.2.22 var

3.2.6.2.23 oper

3.2.6.2.24 delim

3.2.6.2.25 sep

3.2.6.2.26 repsep