bdlscm.h

Go to the documentation of this file.

/// @file bdlscm.h
///
///
/// @defgroup bdlscm Package bdlscm
/// @brief  Basic Development Library Source Control Management (bdlscm)
/// @addtogroup bdl
/// @{
/// @addtogroup bdlscm
/// [bdlscm]: group__bdlscm.html
/// @{
///
/// # Purpose {#bdlscm-purpose}
/// Provide versioning information for BDE library components.
///
/// # Mnemonic {#bdlscm-mnemonic}
/// Basic Development Library Source Control Management (bdlscm)
///
/// @see  bslscm
///
/// # Description {#bdlscm-description}
/// This package provides versioning information that is incorporated
/// into every release of the 'bdl' Package Group Library.  This versioning
/// information is in turn available to all clients of 'bdl' both at run-time and
/// by inspection of appropriate '.o' files.  Note that, except for the package
/// name, this version functionality is repeated in every package group within the
/// BDE library suite.
///
/// ## Hierarchical Synopsis
///
/// The 'bdlscm' package currently has 2 components having 2 levels of physical
/// dependency.  The list below shows the hierarchical ordering of the components.
/// @code
///  2. bdlscm_version
///
///  1. bdlscm_versiontag
/// @endcode
///
/// ## Component Synopsis
///
///  @ref bdlscm_version :
///       Provide source control management (versioning) information.
/// 
///  @ref bdlscm_versiontag :
///       Provide versioning information for the `bdl` package group.
///
/// @}
/** @} */