classsynopsis — The syntax summary for a class definition.


classsynopsis ::= [-]


Common attributes and common linking attributes.

Additional attributes:

  • class (enumeration)
    • “class”
    • “interface”
  • language

Additional Constraints

  • If this element is the root element, it must have a version attribute.


A classsynopsis contains the syntax summary of a class (generally speaking, a class in the object-oriented programming language sense).

This is one of the few places where DocBook attempts to model as well as describe. Unlike funcsynopsis, which was designed with C language function prototypes in mind, the content model of classsynopsis was designed to capture a wide range of object-oriented language semantics.

Processing expectations

For the most part, the processing application is expected to generate all of the parentheses, semicolons, commas, and so on required in the rendered synopsis. The exception to this rule is that the spacing and other punctuation inside a parameter that is a pointer to a function must be provided in the source markup.


Common attributes and common linking attributes.


Specifies the nature of the synopsis

Enumerated values:

This is the synopsis of a class


This is the synopsis of an interface


Identifies the language (i.e. programming language) of the content.

Last revised by Norman Walsh on (git hash: 4a070f84c9fc7bc85cf9f71d71fa54f4db18f973 a835fdf61c7f87ce1038e2869080d80ea67d3696)