Reference. Reference for the DocBook DTD

[Prev] [Next]

FuncSynopsisInfo

Name

FuncSynopsisInfo---Information supplementing the FuncDefs of a FuncSynopsis

Synopsis

Content Model 
  (LineAnnotation | #PCDATA | Link | OLink | ULink | Action
  | Application | ClassName | Command | ComputerOutput
  | Database | Email | EnVar | ErrorCode | ErrorName
  | ErrorType | Filename | Function | GUIButton | GUIIcon
  | GUILabel | GUIMenu | GUIMenuItem | GUISubmenu | Hardware
  | Interface | InterfaceDefinition | KeyCap | KeyCode
  | KeyCombo | KeySym | Literal | Markup | MediaLabel
  | MenuChoice | MouseButton | MsgText | Option | Optional
  | Parameter | Prompt | Property | Replaceable | ReturnValue
  | SGMLTag | StructField | StructName | Symbol | SystemItem
  | Token | Type | UserInput | Anchor | Comment | Subscript
  | Superscript
  | InlineGraphic)*

Attributes

This element has common and Role attributes.

Name Value(s) Type Default Value
Format (linespecific) NOTATION linespecific

Tag Minimization

The start-tag is required for this element. The end-tag is optional, if your SGML declaration allows minimization.

Description

Information supplementing the FuncDefs of a FuncSynopsis. It contains elements of ctprphrase.gp, and within it line breaks and leading white space are significant. See FuncSynopsis. It has common attributes.

Parents

FuncSynopsisInfo occurs in FuncSynopsis.

Children

FuncSynopsisInfo contains these elements: Action, Anchor, Application, ClassName, Command, Comment, ComputerOutput, Database, Email, EnVar, ErrorCode, ErrorName, ErrorType, Filename, Function, GUIButton, GUIIcon, GUILabel, GUIMenu, GUIMenuItem, GUISubmenu, Hardware, InlineGraphic, Interface, InterfaceDefinition, KeyCap, KeyCode, KeyCombo, KeySym, LineAnnotation, Link, Literal, Markup, MediaLabel, MenuChoice, MouseButton, MsgText, OLink, Option, Optional, #PCDATA, Parameter, Prompt, Property, Replaceable, ReturnValue, SGMLTag, StructField, StructName, Subscript, Superscript, Symbol, SystemItem, Token, Type, ULink, and UserInput.

Attributes

Format

Line ends and leading white space must be preserved in output.

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] FuncPrototype
[Next] FuncSynopsis
[Reference Home] [Davenport Group Home]