This is an alpha version of this book.
function ::= (#PCDATA|link|olink|ulink|action|application|classname|methodname| interfacename|exceptionname|ooclass|oointerface|ooexception| command|computeroutput|database|email|envar|errorcode|errorname| errortype|filename|function|guibutton|guiicon|guilabel|guimenu| guimenuitem|guisubmenu|hardware|interface|keycap|keycode| keycombo|keysym|literal|constant|markup|medialabel|menuchoice| mousebutton|option|optional|parameter|prompt|property| replaceable|returnvalue|sgmltag|structfield|structname|symbol| systemitem|token|type|userinput|varname|nonterminal|anchor| remark|subscript|superscript|inlinegraphic|inlinemediaobject| indexterm|beginpage)*
Name |
Type |
Default |
||
| moreinfo |
Enumeration:
|
"none" |
The following parameter entities contain function:
| Parameter Entities | ||
| %cptr.char.mix; | %ndxterm.char.mix; | %para.char.mix; |
| %refinline.char.mix; | %refname.char.mix; | %tbl.entry.mdl; |
| %tech.char.class; | %title.char.mix; | |
This element marks up the name of a function. To markup the parts of a function definition, see FuncSynopsis.
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 ChangesThe InterfaceDefinition element will be discarded in DocBook V4.0. It will no longer be available in the content model of this element.
These elements contain function: application, attribution, bibliomisc, bridgehead, citation, citetitle, classsynopsisinfo, command, computeroutput, emphasis, entry, foreignphrase, funcdef, funcparams, funcsynopsisinfo, function, glosssee, glossseealso, glossterm, lineannotation, link, literal, literallayout, lotentry, member, msgaud, olink, optional, para, phrase, primary, primaryie, productname, programlisting, quote, refdescriptor, refentrytitle, refname, refpurpose, remark, screen, screeninfo, secondary, secondaryie, see, seealso, seealsoie, seeie, seg, segtitle, simpara, subtitle, synopsis, term, tertiary, tertiaryie, title, titleabbrev, tocback, tocentry, tocfront, trademark, ulink, userinput.
The following elements occur in function: action, anchor, application, beginpage, classname, command, computeroutput, constant, database, email, envar, errorcode, errorname, 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, userinput, varname.
funcdef, funcparams, funcprototype, funcsynopsisinfo, paramdef, parameter, returnvalue, varargs, void.
For examples, see funcdef, funcsynopsis, paramdef, programlistingco, returnvalue, structname, type, varargs .
Copyright © 1999, 2000, 2001 O'Reilly & Associates, Inc.