bsldoc.h

Go to the documentation of this file.

/// @file bsldoc.h
///
///
/// @defgroup bsldoc Package bsldoc
/// @brief  Basic Standard Library DOCumentation (bsldoc)
/// @addtogroup bsl
/// @{
/// @addtogroup bsldoc
/// @{
/// * <a href="#bsldoc-purpose"> Purpose</a>
/// * <a href="#bsldoc-mnemonic"> Mnemonic </a>
/// * <a href="#bsldoc-description"> Description </a>
///   * <a href="#bsldoc-hierarchical-synopsis"> Hierarchical Synopsis </a>
///   * <a href="#bsldoc-component-synopsis"> Component Synopsis </a>
///
/// # Purpose {#bsldoc-purpose}
/// Provide documentation of terms and concepts used throughout BDE.
///
/// # Mnemonic {#bsldoc-mnemonic}
/// Basic Standard Library DOCumentation (bsldoc)
///
/// # Description {#bsldoc-description}
/// The 'bsldoc' package provides documentation of terms and concepts
/// used ubiquitously throughout BDE.
///
/// ## Hierarchical Synopsis {#bsldoc-hierarchical-synopsis}
///
/// The 'bsldoc' package currently has 1 component.
/// @code
///  1. bsldoc_glossary
/// @endcode
///
/// ## Component Synopsis {#bsldoc-component-synopsis}
///
///  @ref bsldoc_glossary :
///       Provide definitions for terms used throughout BDE documentation.
///
/// @}
/** @} */