function
function — The name of a function or subroutine, as in a programming language.
Synopsis
function ::=
- Zero or more of:
- text
replaceable- Graphic inlines
- Indexing inlines
- Linking inlines
- Ubiquitous inlines
abbrevacronymaltanchorannotationbibliorefcorefdateemphasis(db._emphasis)firstterm(db._firstterm)footnotefootnoterefforeignphrase(db._foreignphrase)glossterm(db._glossterm)indexterm(db.indexterm.endofrange)indexterm(db.indexterm.singular)indexterm(db.indexterm.startofrange)inlinemediaobjectlinkolinkphrase(db._phrase)quote(db._quote)remarksubscriptsuperscripttrademarkwordaswordxref
Attributes
Common attributes and common linking attributes.
No additional attributes.
Description
This element marks up the name of a function. To mark up the parts
of a function definition, see funcsynopsis.
Processing expectations
Formatted inline.
In some environments, the function element
generates additional punctuation, such as a set of trailing
parentheses.
Attributes
Common attributes and common linking attributes.
- any attribute
Any attribute in any other explicit namespace
Parents
These elements contain function: bridgehead, caption (db.html.caption), citation, citetitle, classsynopsisinfo, code, contrib, emphasis (db.emphasis), entry, enumitemdescription, firstterm (db.firstterm), funcdef, funcsynopsisinfo, glosssee, glossseealso, glossterm (db.glossterm), link, literallayout, member, meta (db.meta.content), olink, orgdiv, para, phrase (db.phrase), primary, primaryie, programlisting, quote (db.quote), refdescriptor, refentrytitle, refname, refpurpose, remark, screen, secondary, secondaryie, see, seealso, seealsoie, seeie, seg, segtitle, simpara, subtitle, synopsis, synopsisinfo, td, term, termdef, tertiary, tertiaryie, th, title, titleabbrev, tocentry, type.
Children
The following elements occur in function: text, abbrev, acronym, alt, anchor, annotation, biblioref, coref, date, emphasis (db._emphasis), firstterm (db._firstterm), footnote, footnoteref, foreignphrase (db._foreignphrase), glossterm (db._glossterm), indexterm (db.indexterm.endofrange), indexterm (db.indexterm.singular), indexterm (db.indexterm.startofrange), inlinemediaobject, link, olink, phrase (db._phrase), quote (db._quote), remark, replaceable, subscript, superscript, trademark, wordasword, xref.
See Also
Related elements: funcdef, funcparams, funcprototype, funcsynopsisinfo, paramdef, parameter, returnvalue, varargs, void.