bslim.h

Go to the documentation of this file.

/// @file bslim.h
///
///
/// @defgroup bslim Package bslim
/// @brief  Basic Standard Library Implementation Mechanisms (bslim)
/// @addtogroup bsl
/// @{
/// @addtogroup bslim
/// @{
/// * <a href="#bslim-purpose"> Purpose</a>
/// * <a href="#bslim-mnemonic"> Mnemonic </a>
/// * <a href="#bslim-description"> Description </a>
///   * <a href="#bslim-hierarchical-synopsis"> Hierarchical Synopsis </a>
///   * <a href="#bslim-component-synopsis"> Component Synopsis </a>
///
/// # Purpose {#bslim-purpose}
/// Provide implementation mechanisms.
///
/// # Mnemonic {#bslim-mnemonic}
/// Basic Standard Library Implementation Mechanisms (bslim)
///
/// # Description {#bslim-description}
/// The 'bslim' package provides implementation mechanisms that are
/// typically used to implement functionality provided by other components.  For
/// example, @ref bslim_printer  greatly simplifies the implementation of standard BDE
/// 'print' methods having this interface:
/// @code
///  bsl::ostream& print(bsl::ostream& stream,
///                      int           level          = 0,
///                      int           spacesPerLevel = 4) const;
/// @endcode
/// The @ref bslim_testutil  component provides a set of macros that are widely used
/// in the test drivers of other BDE components.
///
/// ## Hierarchical Synopsis {#bslim-hierarchical-synopsis}
///
/// The 'bslim' package currently has 8 components having 2 levels of physical
/// dependency.  The list below shows the hierarchical ordering of the components.
/// The order of components within each level is not architecturally significant,
/// just alphabetical.
/// @code
///  2. bslim_fuzzutil
///     bslim_printer
///
///  1. bslim_bslforwardstdheaderstest
///     bslim_bslstandardheadertest
///     bslim_formatguard
///     bslim_fuzzdataview
///     bslim_gtestutil
///     bslim_testutil
/// @endcode
///
/// ## Component Synopsis {#bslim-component-synopsis}
///
///  @ref bslim_bslforwardstdheaderstest :
///       Provide a location for testing `bsl` standard forwarding headers.
/// 
///  @ref bslim_bslstandardheadertest :
///       Provide a location for testing `bsl` standard library headers.
/// 
///  @ref bslim_formatguard :
///       Provide a guard for saving the state of a stream object.
/// 
///  @ref bslim_fuzzdataview :
///       Provide a view of a buffer of fuzz data bytes.
/// 
///  @ref bslim_fuzzutil :
///       Provide fuzz test utilities for basic types.
/// 
///  @ref bslim_gtestutil :
///       Provide facilities for debugging BDE with gtest.
/// 
///  @ref bslim_printer :
///       Provide a mechanism to implement standard `print` methods.
/// 
///  @ref bslim_testutil :
///       Provide test utilities for components above `bsl`.
///
/// @}
/** @} */