FuncSynopsisInfo

Name

FuncSynopsisInfo -- Information supplementing the FuncDefs of a FuncSynopsis

Synopsis

Mixed Content Model

FuncSynopsisInfo ::=
((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|
  Constant|Markup|MediaLabel|MenuChoice|MouseButton|MsgText|
  Option|Optional|Parameter|Prompt|Property|Replaceable|
  ReturnValue|SGMLTag|StructField|StructName|Symbol|SystemItem|
  Token|Type|UserInput|VarName|Anchor|Comment|Subscript|
  Superscript|InlineGraphic|InlineMediaObject|IndexTerm)*)

Attributes

Common attributes

Name

Type

Default

Format

Enumerated notation:

linespecific

"linespecific"

Tag Minimization

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

Description

Supplementary information in a FuncSynopsis. See FuncSynopsis.

Unlike the otherinfo elements, FuncSynopsisInfo is not a container for meta-information. Instead FuncSynopsisInfo is a verbatim environment for adding additional information to a function synopsis.

Processing expectations

This element is displayed "verbatim"; whitespace and linebreaks within this element are significant.

(4.0) Future Changes

The InterfaceDefinition element will be discarded in DocBook V4.0. It will no longer be available in the content model of this element.

Parents

These elements contain FuncSynopsisInfo: FuncSynopsis.

Children

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

In some contexts, the following elements are allowed anywhere: BeginPage, IndexTerm.

In some contexts, the following elements are excluded: IndexTerm.

Attributes

Format

The Format attribute applies the linespecific notation to all FuncSynopsisInfos. All white space and line breaks must be preserved.

See Also

FuncDef, FuncParams, FuncPrototype, Function, ParamDef, Parameter, ReturnValue, VarArgs, Void

Examples

For examples, see FuncSynopsis, VarArgs.

Copyright © 1999 O'Reilly & Associates, Inc. All rights reserved.