BoostBook element library-reference . Boost , The Boost C++ Libraries BoostBook Documentation Subset , Reference

BoostBook element `library-reference`

library-reference — Declares the reference material for a library

Synopsis

library-reference ::= (title?, section*, (header| library-reference)*)

Description

Справочная документация для библиотеки содержит элемент. Элементне имеет атрибутов и содержит в качестве детей только

элементы.

Элемент

определяет файл заголовка C++. В каждом файле заголовка C++ лежат определения конструкций C++, которые должны быть документированы. Атрибут<name>элемента

дает имя заголовка, как указано при включении заголовка. Например, библиотечный справочник для библиотекиЛюбая библиотекаможет выглядеть следующим образом:

<library-reference>
  <header name="boost/any.hpp">
    <!-- C++ constructs in this header -->
  </header>
</library-reference>

Если бы библиотекаAnyсодержала несколько заголовков, мы бы перечислили их всех как детей элемента «Библиотека-справка».

<library-reference>Элементы могут быть вложены, так что исходный материал может быть разделен на отдельные разделы, каждый из которых содержит различные заголовки.

Attributes

Name	Type	Value	Purpose
последний пересмотр	#ИМПЛИД	CDATA	Настройка на $Date$ для сохранения «последней пересмотренной» информации в синхронизации с изменениями CVS
id	#ИМПЛИД	CDATA	Глобальный идентификатор этого элемента
xml - база	#ИМПЛИД	CDATA	Детали реализации, используемые XIncludes

Статья BoostBook element library-reference раздела The Boost C++ Libraries BoostBook Documentation Subset Reference может быть полезна для разработчиков на c++ и boost.