Документация ориентирована как на новых, так и на опытных пользователей библиотеки. Однако ожидается, что пользователи будут знакомы с широко используемыми компонентами Boost, такими как<shared_ptr
>,<make_shared
>(см.Boost.SmartPtr) и<function
>(Boost.Function).. Некоторые части документации будут относиться к другим библиотекам Boost по мере необходимости.
Если это ваш первый опыт работы с библиотекой, рекомендуется прочитать разделОбзор дизайнадля первого взгляда на возможности и архитектуру библиотеки. РазделыУстановкаиУчебникпомогут начать экспериментировать с библиотекой. Учебник дает обзор функций библиотеки с образцами фрагментов кода. Некоторые учебные шаги представлены в двух формах: простые и продвинутые. Простая форма обычно описывает наиболее распространенный и простой способ выполнения задачи, и ее рекомендуется читать новым пользователям. Продвинутая форма обычно дает расширенный способ сделать то же самое, но с глубоким объяснением и возможностью сделать некоторую дополнительную настройку. Эта форма может пригодиться для более опытных пользователей и, как правило, должна быть прочитана, если простой способ не удовлетворяет ваши потребности.
Помимо учебника естьПодробное описание функцийглава. В этой части описаны другие инструменты, предоставленные библиотекой, которые не были охвачены учебником. Эту главу лучше читать в каждом конкретном случае.
И последнее, но не менее важное: существует ссылка, которая дает формальное описание компонентов библиотеки.
Чтобы сохранить фрагменты кода в этой документации простыми, предполагается определить следующие псевдонимы пространства имен:
namespace logging = boost::log;
namespace sinks = boost::log::sinks;
namespace src = boost::log::sources;
namespace expr = boost::log::expressions;
namespace attrs = boost::log::attributes;
namespace keywords = boost::log::keywords;