Parameter lists

When documenting programming functions and interfaces, the parameter list can be used to explain parameters passed between applications and functions.

Parameter lists are a special purpose list used to describe parameters in a program or application programming interface. The parameter list (parml) is similar in structure to the general purpose definition list (dl).

A parameter list (parml) element contains one or more parameter list entry (plentry) elements, each typically containing a parameter name or term (pt) and a parameter description (pd) element.

An example of a parameter list being used to explain some programming code is:
<codeblock>callHelp(hFilename, contentId)</codeblock>
<p>where
<parml>
 <plentry>
  <pt>hFileName</pt>
  <pd>is the relative path to the Help file</pd>
 </plentry>
 <plentry>
  <pt>contentId</pt>
  <pd>is the context ID of the topic to display</pd>
 </plentry>
</parml>
</p>