balscm.h

Go to the documentation of this file.

/// @file balscm.h
///
///
/// @defgroup balscm Package balscm
/// @brief  Basic Application Library Source Control Management (balscm)
/// @addtogroup bal
/// @{
/// @addtogroup balscm
/// [balscm]: group__balscm.html
/// @{
///
/// # Purpose {#balscm-purpose}
/// Provide versioning information for library components in 'bal'.
///
/// # Mnemonic {#balscm-mnemonic}
/// Basic Application Library Source Control Management (balscm)
///
/// @see  bslscm
///
/// # Description {#balscm-description}
/// This package is for use only by the BDE library.  Components in
/// the 'bal' package group include this component in order to generate versioning
/// information.  Developers use this versioning information to track releases of
/// individual components when diagnosing problems using the 'bal' library.
///
/// This component is only used within the 'bal' package group.  Each BDE package
/// group contains a similar component that provides the same functionality for
/// components in that package group.  Thus separate package groups can be
/// deployed independently from one another.
///
/// In normal usage, developers should not need to refer to this component.
///
/// ## Hierarchical Synopsis
///
/// The 'balscm' package currently has 2 components having 2 levels of physical
/// dependency.  The list below shows the hierarchical ordering of the components.
/// @code
///  2. balscm_version
///
///  1. balscm_versiontag
/// @endcode
///
/// ## Component Synopsis
///
///  @ref balscm_version :
///       Provide source control management (versioning) information.
/// 
///  @ref balscm_versiontag :
///       Provide versioning information for the `bal` package group.
///
/// @}
/** @} */