Name
classsynopsis — The syntax summary for a class definition
Synopsis
classsynopsis ::=
(Object-oriented programming inlines+,
(classsynopsisinfo |
constructorsynopsis |
destructorsynopsis | fieldsynopsis
| methodsynopsis)*)
Attribute synopsis
Common attributes and common linking attributes.
Additional attributes:
class(enumeration) = “class” | “interface”language
Description
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.
Attributes
Common attributes and common linking attributes.
- class
Specifies the nature of the synopsis
Enumerated values: “class” This is the synopsis of a class.
“interface” This is the synopsis of an interface.
- language
Identifies the language (i.e., programming language) of the content
Get DocBook 5: The Definitive Guide now with the O’Reilly learning platform.
O’Reilly members experience books, live events, courses curated by job role, and more from O’Reilly and nearly 200 top publishers.
