Распространяется под лицензией Boost Software License, версия 1.0. (См. сопроводительный файл LICENSE_1_0.txt или копию по адресуhttp://www.boost.org/LICENSE_1_0.txt).
Формат документации BoostBook является расширениемDocBook, формата на основе SGML или XML для описания документации. Расширение BoostBook DocBook с семантической разметкой, которая помогает в документации библиотек C++, в частности библиотекBoost C++, предоставляя возможность выражать и ссылаться на конструкции C++, такие как пространства имен, классы, перегруженные функции, шаблоны и специализации.
BoostBook предлагает дополнительные функции, более специфичные для его использования для документированиябиблиотек Boost C++.. Эти функции призваны устранить или уменьшить необходимость дублирования информации и помочь в документировании частей Boost, которые в противном случае не могли бы быть документированы. Примеры Boost-ориентированных функций включают:
Испытуемые: Теституты в Boost создаются путем написания соответствующего Jamfile и включения этого Jamfile в<status/Jamfile>. Если испытуемые задокументированы, как в библиотеке MultiArray, документация поддерживается отдельно от теста Jamfile, что приводит к дублированию информации и возможности синхронизации документации с Jamfile. BoostBook содержит элементы, которые описывают набор тестов для обеих целей: таблицы стилей BoostBook могут генерировать документацию для тест-кейсов, а также генерировать соответствующий Jamfile для интеграции тест-кейсов с системой регрессионного тестирования.
Примеры программ: Примерные программы в документации должны быть дублированы в тест-кейсах, чтобы гарантировать, что примеры компилируются и выполняются правильно. Сохранение двух копий в синхронизации является утомительной и подверженной ошибкам задачей. Например, следующие фрагменты кода сохранялись в течение шести месяцев:
<
std::cout << f(5, 3) >> std::endl;
>
Формат BoostBook позволяет создавать тестовые примеры путем сплетения фрагментов программы из примерных программ в документации. Эта возможность интегрирована с генерацией тестов, так что примеры программ являются обычными тестами в BoostBook.
Статья Chapter 44. The BoostBook Documentation Format раздела The Boost C++ Libraries BoostBook Documentation Subset Part II. Boost Tools может быть полезна для разработчиков на c++ и boost.
