methodparam

$Revision: 1.2 $

$Date: 2002/06/11 01:20:04 $

methodparam — Parameters to a method

Synopsis

Content Model

methodparam ::=
(modifier*,type?,
 ((parameter,initializer?)|
  funcparams),
 modifier*)

Attributes

Common attributes

Name

Type

Default

choice

Enumeration:

opt

plain

req

"req"

rep

Enumeration:

norepeat

repeat

"norepeat"

DocBook NG “Bourbon” Content Model

methodparam ::=

Sequence of:

Zero or more of:

modifier

type?
One of:

Sequence of:

parameter
initializer?

funcparams

Zero or more of:

modifier

DocBook NG “Bourbon” Attributes

Common attributes and common linking attributes.

Additional attributes: (Required attributes, if any, are bold)

choice (enumeration)
- “opt”
- “plain”
- “req”
rep (enumeration)
- “norepeat”
- “repeat”

Description

In the syntax summary of a ConstructorSynopsis, DestructorSynopsis, or MethodSynopsis, MethodParam 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.

Processing expectations

Formatted inline. For a complete description of the processing expectations, see ClassSynopsis.

Parents

These elements contain methodparam: constructorsynopsis, destructorsynopsis, methodsynopsis.

Children

The following elements occur in methodparam: funcparams, initializer, modifier, parameter, type.

Attributes

choice: Choice indicates whether the MethodParam is required (Req or Plain) or optional (Opt). Arguments identified as Plain are required, but are shown without additional decoration.
rep: A Rep value of Repeat indicates that the MethodParam is reapeatable.


methodname		methodsynopsis