1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
|
<refentry id="methodparam.element" revision='4.0'>
<?dbhtml filename="methodparam.html"?>
<refentryinfo>
<pubdate>$Date$</pubdate>
<releaseinfo>$Revision$</releaseinfo>
</refentryinfo>
<refmeta>
<indexterm><primary>elements</primary>
<secondary>methodparam</secondary></indexterm>
<refentrytitle>methodparam</refentrytitle>
<refmiscinfo>Element</refmiscinfo>
</refmeta>
<refnamediv>
<refname>methodparam</refname>
<refpurpose>&methodparam.purpose;</refpurpose>
</refnamediv>
&methodparam.synopsis.gen;
<refsect1 condition='ref.description'><title>Description</title>
<para>
In the syntax summary of a <sgmltag>ConstructorSynopsis</sgmltag>,
<sgmltag>DestructorSynopsis</sgmltag>, or
<sgmltag>MethodSynopsis</sgmltag>,
<sgmltag>MethodParam</sgmltag> provides the description of a parameter to the
method. Typically, this includes the data type of the parameter
and its name, but may also include an initial value and other modifiers.
</para>
<refsect2><title>Processing expectations</title>
<para>
&format.inline; For a complete description of the processing expectations,
see <sgmltag>ClassSynopsis</sgmltag>.
</para>
</refsect2>
&methodparam.parents.gen;
&methodparam.children.gen;
</refsect1>
<refsect1 condition='ref.elem.attrdesc'><title>Attributes</title>
<variablelist>
<varlistentry><term>choice</term>
<listitem>
<para revision="4.0">
<sgmltag class="attribute">Choice</sgmltag> indicates whether the
<sgmltag>MethodParam</sgmltag>
is required (<literal>Req</literal> or <literal>Plain</literal>) or
optional (<literal>Opt</literal>). Arguments identified as
<literal>Plain</literal> are required, but are shown without additional
decoration.</para>
</listitem>
</varlistentry>
<varlistentry><term>rep</term>
<listitem>
<para revision="4.0">
A <sgmltag class="attribute">Rep</sgmltag> value of
<literal>Repeat</literal> indicates that the
<sgmltag>MethodParam</sgmltag> is reapeatable.
</para>
</listitem>
</varlistentry>
</variablelist>
</refsect1>
</refentry>
|
