function

DocBook 5: The Definitive Guide (Version 1.0.4 for DocBook V5.0)

function

function — The name of a function or subroutine, as in a programming language.

Synopsis

Zero or more of:
- text
- phrase (db._phrase)
- replaceable
- Graphic inlines
  inlinemediaobject
- Indexing inlines
  indexterm (db.indexterm.endofrange)
  indexterm (db.indexterm.singular)
  indexterm (db.indexterm.startofrange)
- Linking inlines
  anchor
  biblioref
  link
  olink
  xref
- Ubiquitous inlines
  alt
  anchor
  annotation
  biblioref
  indexterm (db.indexterm.endofrange)
  indexterm (db.indexterm.singular)
  indexterm (db.indexterm.startofrange)
  inlinemediaobject
  link
  olink
  remark
  subscript
  superscript
  xref

Attributes

Common attributes and common linking 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.

Parents

This element occurs in 51 elements.

Children

This element contains 16 elements.

See Also

funcdef, funcparams, funcprototype, funcsynopsisinfo, paramdef, parameter, returnvalue, varargs, void


funcsynopsisinfo		glossary

Last revised by Norman Walsh on 6 Jun 2011 (git hash: 6ffcc7640bbc5f852a318e452c9f210f03292cb9)

Copyright © 2010, 2011 Norman Walsh.