bal.h

Go to the documentation of this file.

/// @file bal.h
///
///
/// @defgroup bal Group bal
/// @brief  Basic Application Library (bal)
/// @addtogroup bal
/// @{
/// * <a href="#bal-purpose"> Purpose</a>
/// * <a href="#bal-mnemonic"> Mnemonic </a>
/// * <a href="#bal-description"> Description </a>
///   * <a href="#bal-hierarchical-synopsis"> Hierarchical Synopsis </a>
///   * <a href="#bal-package-synopsis"> Package Synopsis </a>
///
/// # Purpose {#bal-purpose}
/// Provide application-level support services.
///
/// # Mnemonic {#bal-mnemonic}
/// Basic Application Library (bal)
///
/// # Description {#bal-description}
/// The 'bal' ("Basic Applications Library") package group contains
/// packages that provide application-level support services in varied areas such
/// as encoders/decoders, timezone support, command-line handling, metrics, and
/// logging.
///
/// ## Hierarchical Synopsis {#bal-hierarchical-synopsis}
///
/// The 'bal' package group currently has 10 packages having 4 levels of physical
/// dependency.  The list below shows the hierarchical ordering of the packages.
/// The order of packages within each level is not architecturally significant,
/// just alphabetical.
/// @code
///  4. ball
///
///  3. baljsn
///
///  2. balb
///     balber
///     balcl
///     balm
///     balst
///     baltzo
///     balxml
///
///  1. balscm
/// @endcode
///
/// ## Package Synopsis {#bal-package-synopsis}
///
///  'balb':
///       Provide common application-level facilities.
/// 
///  'balber':
///       Provide encoding/decoding of data per the (binary) BER rules.
/// 
///  'balcl':
///       Provide facility to parse process command-line arguments.
/// 
///  'baljsn':
///       Provide components for encoding/decoding in the JSON format.
/// 
///  'ball':
///       Provide thread-safe logging toolkit suitable for all platforms.
/// 
///  'balm':
///       Provide thread-safe collection and publishing of metrics.
/// 
///  'balscm':
///       Provide versioning information for library components in 'bal'.
/// 
///  'balst':
///       Provide a portable facility for obtaining & printing a stack trace.
/// 
///  'baltzo':
///       Provide timezone data for use with timezone-enabled vocabulary types.
/// 
///  'balxml':
///       Provide utility components for using XML and XSD.
///
/// @}