<parml>

A parameter list is a specialized definition list that is designed for documenting parameters.

Specialization hierarchy

The <parml> element is specialized from <dl>. It is defined in the programming domain module.

Content model

( <data> | <sort-as> )*, <plentry> +

Contained by

<dd> , <desc> , <div> , <draft-comment> , <entry> , <example> , <fallback> , <fig> , <figgroup> , <fn> , <li> , <lq> , <note> , <p> , <pd> , <stentry>

In order
  1. Zero or more of the following
    • <data>
    • <sort-as>
  2. One or more <plentry>

Contained by

  • <dd>
  • <desc>
  • <div>
  • <draft-comment>
  • <entry>
  • <example>
  • <fallback>
  • <fig>
  • <figgroup>
  • <fn>
  • <li>
  • <lq>
  • <note>
  • <p>
  • <pd>
  • <stentry>

Inheritance

+ topic/dl pr-d/parml

The <parml> element is specialized from <dl> . It is defined in the pr-domain module.

Attributes

The following attributes are available on this element: universal attributes and @compact.

The following attributes are available on this element: universal attributes and the attributes defined below.

@compact
Specifies whether the vertical spacing between list items is tightened. The following values are valid: yes, no, and -dita-use-conref-target. Some DITA processors or output formats might not support the @compact attribute.

Example

This section is non-normative.

The following code sample shows how a set of sample code is followed by a parameter list that defines those parameters:

<p>This code example is a basic method signature:</p>
<codeblock>returnType methodName(pList1, pList2)</codeblock>
<p>The method requires the following parameters:</p>
<parml>
  <plentry>
    <pt>pList1</pt>
    <pd>The first variable declaration that is passed to methodName</pd>
  </plentry>
  <plentry>
    <pt>pList2</pt>
    <pd>The second variable declaration that is passed to methodName</pd>
  </plentry>
</parml>