[Prev] [Next]

FuncDef

Name

Synopsis

  (#PCDATA | Replaceable | Function)*

Attributes

This element has common and Role attributes.

Tag Minimization

Both the start- and end-tags are required for this element.

Description

Function or routine name and its return type in a FuncSynopsis Like Paramdef, FuncDef provides data type information and the name of the Function (or Parameter, in the case of ParamDef) this information applies to. A FuncDef may contain any combination of plain text, Replaceable, Data, or Function, in any order. It has common attributes.

Separating this information from the rest of the synopsis avoids messing with data type information that appears before or after the item it applies to, such as array information ("[]"). It also avoids the issue of placing the pointer ("*") indicator (next to the rest of the left-hand data type or next to the Parameter or Function name?). Any spaces that surround the Parameter or Function must be inserted by the writer.

Parents

These elements contain FuncDef: FuncPrototype, and FuncSynopsis.

Children

FuncDef contains these elements: Function, #PCDATA, and Replaceable.

Examples

<FUNCSYNOPSIS>
<FUNCSYNOPSISINFO>#include &lt;stdlib.h></FUNCSYNOPSISINFO>
<FUNCDEF>double <FUNCTION>atof</FUNCTION></FUNCDEF>
<PARAMDEF>const char *<PARAMETER>nptr</PARAMETER></PARAMDEF>
</FUNCSYNOPSIS>

<FUNCSYNOPSIS>
<FUNCSYNOPSISINFO>TODO TBS
</FUNCSYNOPSISINFO>
<FUNCPROTOTYPE>
<FUNCDEF>TODO TBS
</FUNCDEF>
<VOID>
</FUNCPROTOTYPE>
</FUNCSYNOPSIS>

[Prev] formalobject.title.content
[Next] FuncParams
[Reference Home] [Davenport Group Home]