|
Reference
Элементы:
- 1 Элемент<
access>- Объявляет спецификацию доступа для членов класса
- Элемент<
boostbook>- Книга-рассказчик
- (7) Элемент<
class>- Объявляет класс или шаблон класса
- (10) Элемент<
class-specialization>- Специализация (частичная или полная) шаблона класса
- Элемент<
code>- Подражает тегу<code>в HTML
- Элемент<
compile-fail-test>— Пример, который не должен компилироваться
- 20 Элемент<
compile-test>- Вещество, которое должно составляться правильно
- Элемент<
complexity>- Время/пространство/и т.д. сложность функции
- Элемент<
constructor>- объявляет конструктора ограждающего класса
- Элемент<
copy-assignment>— объявляет оператора копирования
- 32 Элемент<
data-member>- Объявляет члена данных класса
- 35 Элемент<
default>- значение по умолчанию функции или параметра шаблона
- 38 Элемент<
description>Подробное описание конструкции
- Элемент<
destructor>- Объявляет деструктор для замкнутого класса
- Элемент<
effects>— Объявляет побочные эффекты функции
- Элемент<
enum>- Объявляет тип перечисления
- 50 Элемент<
enumname>- Ссылки на тип перечисления с заданным именем
- Элемент<
enumvalue>— единственное значение перечня
- Элемент<
free-function-group>— набор функций, сгруппированных под одним именем.
- Элемент<
function>— объявляет функцию
- Элемент<
functionname>- Ссылки на функцию с заданным именем
- Элемент<
globalname>- Ссылки на глобальный с данным именем
- Элемент<
header>— объявляет заголовок C++ с заданным именем
- Элемент<
headername>— ссылки на заголовок C++ с заданным именем
- Элемент<
if-fails>— Что значит, когда не работает ячейка
- Элемент<
inherit>- Объявляет базовый класс ограждающего класса или структуры
- Элемент<
lib>— библиотечная зависимость
- Элемент<
library>— элемент верхнего уровня для библиотеки
- Элемент<
library-reference>- Объявляет справочный материал для библиотеки
- Элемент<
librarycategory>Объявляет, что библиотека находится в этой категории
- Элемент<
librarycategorydef>- Определение новой категории библиотеки
- Элемент<
librarycategorylist>- Категоризированный список библиотек
- Элемент<
libraryinfo>- предоставляет информацию о библиотеке
- элемент<
librarylist>- Владелец алфавитного списка библиотек
- Элемент<
libraryname>— ссылки на библиотеку данного имени
- (107) Элемент<
librarypurpose>— описывает в одном коротком предложении или фразе назначение библиотеки
- Элемент<
link-fail-test>- Объявляет тест, который должен составляться, но не связывать
- 113 Элемент<
link-test>- Объявляет тест, который должен составлять и связывать
- (116) Элемент<
macroname>- Ссылки на макрос с заданным именем
- Элемент<
method>- Объявляет способ, т.е. функцию члена
- Элемент<
method-group>— совокупность методов, сгруппированных под одним именем
- (125) Элемент<
namespace>Объявляет пространство имен
- 128 Элемент<
notes>— Ненормативные заметки о семантике функции
- Элемент<
overloaded-function>— Перегруженная функция
- Элемент<
overloaded-method>— Перегруженный способ
- Элемент<
parameter>— параметр функции
- (140) Элемент<
paramtype>- Тип функционального параметра
- элемент<
postconditions>- Условия, которые должны сохраняться после возвращения функции
- элемент<
precondition>- Условия, которые должны быть выполнены до выполнения функции
- Элемент<
programlisting>— образец программного кода
- Элемент<
purpose>— краткое описание использования объекта
- элемент<
rationale>- Описывает обоснование конструкции конкретной функции
- Элемент<
requirement>— Требование/свойство в Джамфиле для теста
- Элемент<
requires>— Объявляет требования функции
- (164) Элемент<
returns>- Описание возвращаемого значения функции
- Элемент<
run-fail-test>— Пример, который должен компилироваться и связывать, но не выполняться
- (170) Элемент<
run-test>- Пример, который должен компилировать, связывать и выполнять
- 173 Элемент<
signature>- Одна подпись перегруженной функции или метода
- Элемент<
snippet>- выводит фрагмент кода из<programlisting>элемента
- Элемент<
source>- Определение исходного кода для теста
- (183) Элемент<
specialization>- Определение аргументов специализации для классовой специализации
- Элемент<
static-constant>- Объявляет статическую постоянную, например,<const int foo = 5;>.
- 190 Элемент<
struct>- Объявляет структуру C++
- Элемент<
struct-specialization>- Специализация (полная или частичная) шаблона структуры
- Элемент<
template>— Объявляет шаблонные параметры класса или функции
- Элемент<
template-arg>— шаблонный аргумент в специализации
- Элемент<
template-nontype-parameter>— нетипичный параметр шаблона
- Элемент<
template-type-parameter>— объявляет параметр типа шаблона
- Элемент<
template-varargs>- Объявляет список параметров шаблона переменной длины
- Элемент<
testsuite>— описывает библиотечный скафандр
- Элемент<
throws>- Описание исключений, выбрасываемых функцией
- Элемент<
type>— тип элемента или тип возврата функции
- Элемент<
typedef>— объявляет типдеф
- Элемент<
union>- Объявляет C++ союз или шаблон союза
- Элемент<
union-specialization>- Специализация (полная или частичная) шаблона союза
- Элемент<
using-class>- Вводим названия способа и функции класса в локальный объем
- Элемент<
using-namespace>— Впрыскивает объявленные имена из пространства имен в локальный объем
Статья Reference раздела The Boost C++ Libraries BoostBook Documentation Subset Chapter 44. The BoostBook Documentation Format может быть полезна для разработчиков на c++ и boost.
:: Главная :: Chapter 44. The BoostBook Documentation Format ::
|
|
