    | DocBook: The Definitive Guide 2.0.10 (Alpha) |
function
$Revision: 1.3 $
$Date: 2002/06/12 11:18:11 $
function — The name of a function or subroutine, as in a programming language
Synopsis
Mixed Content Model
function ::= (#PCDATA|link|olink|ulink|action|application|classname|methodname| interfacename|exceptionname|ooclass|oointerface|ooexception| command|computeroutput|database|email|envar|errorcode|errorname| errortype|errortext|filename|function|guibutton|guiicon|guilabel| guimenu|guimenuitem|guisubmenu|hardware|interface|keycap|keycode| keycombo|keysym|literal|code|constant|markup|medialabel| menuchoice|mousebutton|option|optional|parameter|prompt|property| replaceable|returnvalue|sgmltag|structfield|structname|symbol| systemitem|uri|token|type|userinput|varname|nonterminal|anchor| remark|subscript|superscript|inlinegraphic|inlinemediaobject| indexterm|beginpage)*
Attributes
Name | Type | Default | |||
| moreinfo |
| "none" |
Description
This element marks up the name of a function. To markup the parts of a function definition, see FuncSynopsis.
Processing expectations
Formatted inline. The MoreInfo attribute can help generate a link or query to retrieve additional information.
In some environments, the Function element generates additional punctuation, such as a set of trailing parenthesis.
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 function: action, application, attribution, bibliomisc, bridgehead, citation, citetitle, classsynopsisinfo, code, command, computeroutput, database, emphasis, entry, filename, firstterm, foreignphrase, funcdef, funcparams, funcsynopsisinfo, function, glosssee, glossseealso, glossterm, hardware, interfacename, keycap, lineannotation, link, literal, literallayout, lotentry, member, msgaud, olink, option, optional, para, parameter, phrase, primary, primaryie, productname, programlisting, property, quote, refdescriptor, refentrytitle, refname, refpurpose, remark, screen, screeninfo, secondary, secondaryie, see, seealso, seealsoie, seeie, seg, segtitle, simpara, subtitle, synopsis, systemitem, td, term, tertiary, tertiaryie, th, title, titleabbrev, tocback, tocentry, tocfront, trademark, ulink, userinput.
Children
The following elements occur in function: action, anchor, application, beginpage, classname, code, command, computeroutput, constant, database, email, envar, errorcode, errorname, errortext, errortype, exceptionname, filename, function, guibutton, guiicon, guilabel, guimenu, guimenuitem, guisubmenu, hardware, indexterm, inlinegraphic, inlinemediaobject, interface, interfacename, keycap, keycode, keycombo, keysym, link, literal, markup, medialabel, menuchoice, methodname, mousebutton, nonterminal, olink, ooclass, ooexception, oointerface, option, optional, parameter, prompt, property, remark, replaceable, returnvalue, sgmltag, structfield, structname, subscript, superscript, symbol, systemitem, token, type, ulink, uri, userinput, varname.
See Also
funcdef, funcparams, funcprototype, funcsynopsisinfo, paramdef, parameter, returnvalue, varargs, void.
Examples
For examples, see funcdef, funcparams, funcsynopsis, paramdef, programlistingco, refentry, returnvalue, structname, type, varargs.
|
|
| |
| funcsynopsisinfo |
| glossary |