Boost C++ Libraries Home Libraries People FAQ More

PrevUpHomeNext

BoostBook element method

method — Declares a method, i.e., a member function

Synopsis

method ::= (template?, type, parameter*, purpose?, description?, requires?, effects?, postconditions?, returns?, throws?, complexity?, notes?, rationale?)

Description

General documentation on functions in BoostBook is provided in the function element documentation.

Attributes

Name Type Value Purpose
last-revision #IMPLIED CDATA Set to $Date$ to keep "last revised" information in sync with CVS changes
cv #IMPLIED CDATA cv-qualifiers for this method, e.g., const volatile
specifiers #IMPLIED CDATA The specifiers for this function, e.g., inline, static, etc.
name #REQUIRED CDATA The name of the element being declared to referenced
id #IMPLIED CDATA A global identifier for this element
xml:base #IMPLIED CDATA Implementation detail used by XIncludes

PrevUpHomeNext