BoostBook element class
class — Declares a class or class template
Synopsis
Description
Классы C++ и шаблоны классов описываются через элемент. Каждый класс имеет имя (например, «любой»), данное атрибутом<name
>, назначение, данное элементом, документацией и набором типов, функций, базовых классов и членов данных. Вот минимальное определение класса<boost::any
>:
<namespace name="boost">
<class name="any">
<purpose>
A class whose instances can hold instances of any type that satisfies
ValueType requirements.
</purpose>
</class>
</namespace>
Дополнительная документация по классу может содержаться в элементе<description
>, следующем за элементом. Эта документация будет набором перед документацией для конкретных элементов в классе (например, конструкторов или методов).
Классовое наследование описывается через элемент. Элементтребует атрибута<access
>, который должен быть одним изобщедоступных,защищенных.иличастный. Содержание элемента в коде C++, который называет унаследованный класс и может содержать разметку для ссылки на класс. Следующее описание класса<boost::bad_any_cast
>описывает общественное наследование от класса<std::bad_cast
>. Он также определяет<цель>элемент, который содержит краткое описание использования класса.
<class name="bad_any_cast">
<inherit access="public"><classname>std::bad_cast</classname></inherit>
<purpose><para>The exception thrown in the event of a failed
<functionname>any_cast</functionname> of an
<classname>any</classname> value.</para></purpose>
</class>
Шаблоны классов определяютсяэлементами сдетским элементом в начале.