BDE 4.39.x Production Release
Loading...
Searching...
No Matches
balscm.h
Go to the documentation of this file.
1/// @file balscm.h
2///
3///
4/// @defgroup balscm Package balscm
5/// @brief Basic Application Library Source Control Management (balscm)
6/// @addtogroup bal
7/// @{
8/// @addtogroup balscm
9/// @{
10/// * <a href="#balscm-purpose"> Purpose</a>
11/// * <a href="#balscm-mnemonic"> Mnemonic </a>
12/// * <a href="#balscm-description"> Description </a>
13/// * <a href="#balscm-hierarchical-synopsis"> Hierarchical Synopsis </a>
14/// * <a href="#balscm-component-synopsis"> Component Synopsis </a>
15///
16/// # Purpose {#balscm-purpose}
17/// Provide versioning information for library components in 'bal'.
18///
19/// # Mnemonic {#balscm-mnemonic}
20/// Basic Application Library Source Control Management (balscm)
21///
22/// @see bslscm
23///
24/// # Description {#balscm-description}
25/// This package is for use only by the BDE library. Components in
26/// the 'bal' package group include this component in order to generate versioning
27/// information. Developers use this versioning information to track releases of
28/// individual components when diagnosing problems using the 'bal' library.
29///
30/// This component is only used within the 'bal' package group. Each BDE package
31/// group contains a similar component that provides the same functionality for
32/// components in that package group. Thus separate package groups can be
33/// deployed independently from one another.
34///
35/// In normal usage, developers should not need to refer to this component.
36///
37/// ## Hierarchical Synopsis {#balscm-hierarchical-synopsis}
38///
39/// The 'balscm' package currently has 2 components having 2 levels of physical
40/// dependency. The list below shows the hierarchical ordering of the components.
41/// @code
42/// 2. balscm_version
43///
44/// 1. balscm_versiontag
45/// @endcode
46///
47/// ## Component Synopsis {#balscm-component-synopsis}
48///
49/// @ref balscm_version :
50/// Provide source control management (versioning) information.
51///
52/// @ref balscm_versiontag :
53/// Provide versioning information for the `bal` package group.
54///
55/// @}
56/** @} */