Skip to content

Commit

Permalink
Cleanup documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
@osubboo
osubboo committed Oct 4, 2024
1 parent 37d3b2f commit 957c036
Show file tree
Hide file tree
Showing 17 changed files with 611 additions and 624 deletions.
49 changes: 23 additions & 26 deletions groups/bal/balb/balb_filecleanerconfiguration.h
View file
Original file line number Diff line number Diff line change
Expand Up @@ -100,8 +100,7 @@ namespace balb {
// ==============================

/// This simply constrained (value-semantic) attribute class characterizes
/// configuration parameters for a file cleaner. See the {Attributes}
/// section under @DESCRIPTION in the component-level documentation for
/// configuration parameters for a file cleaner. See the [](#Attributes) for
/// information on the class attributes. Note that the class invariants are
/// identically the constraints on the individual attributes.
///
Expand Down Expand Up @@ -135,37 +134,36 @@ class FileCleanerConfiguration {
// CREATORS

/// Create a file cleaner configuration object having default values for
/// all attributes. Optionally specify a `basicAllocator` used to
/// supply memory. If `basicAllocator` is 0, the currently installed
/// default allocator is used.
/// all attributes. Optionally specify a `basicAllocator` used to supply
/// memory. If `basicAllocator` is 0, the currently installed default
/// allocator is used.
explicit FileCleanerConfiguration(bslma::Allocator *basicAllocator = 0);

/// Create a file cleaner configuration object having the specified
/// `filePattern`, `maxAge`, and `minNumber` attribute values.
/// Optionally specify a `basicAllocator` used to supply memory. If
/// `basicAllocator` is 0, the currently installed default allocator is
/// used.
/// `filePattern`, `maxAge`, and `minNumber` attribute values. Optionally
/// specify a `basicAllocator` used to supply memory. If `basicAllocator`
/// is 0, the currently installed default allocator is used.
FileCleanerConfiguration(const bsl::string_view& filePattern,
const bsls::TimeInterval& maxAge,
int minNumber,
bslma::Allocator *basicAllocator = 0);

/// Create a file cleaner configuration object having the in-core value
/// of the specified `original` object. Optionally specify a
/// `basicAllocator` used to supply memory. If `basicAllocator` is 0,
/// the currently installed default allocator is used.
/// Create a file cleaner configuration object having the in-core value of
/// the specified `original` object. Optionally specify a `basicAllocator`
/// used to supply memory. If `basicAllocator` is 0, the currently
/// installed default allocator is used.
FileCleanerConfiguration(
const FileCleanerConfiguration& original,
bslma::Allocator *basicAllocator = 0);

/// Destroy this object.
//! ~FileCleanerConfiguration() = default;
// Destroy this object.

// MANIPULATORS

/// Assign to this file cleaner configuration object the in-core value
/// of the specified `rhs` object, and return a reference providing
/// modifiable access to this object.
/// Assign to this file cleaner configuration object the in-core value of
/// the specified `rhs` object, and return a reference providing modifiable
/// access to this object.
FileCleanerConfiguration& operator=(const FileCleanerConfiguration& rhs);

/// Set the file pattern attribute of this object to the specified
Expand All @@ -176,8 +174,8 @@ class FileCleanerConfiguration {
/// `maxAge`.
void setMaxFileAge(const bsls::TimeInterval& maxAge);

/// Set the minimum number of files to keep attribute of this object to
/// the specified `minNumber`.
/// Set the minimum number of files to keep attribute of this object to the
/// specified `minNumber`.
void setMinNumFiles(int minNumber);

// ACCESSORS
Expand Down Expand Up @@ -208,10 +206,10 @@ class FileCleanerConfiguration {

// FREE OPERATORS

/// Return `true` if the specified `lhs` and `rhs` attribute objects have
/// the same (in-core) value, and `false` otherwise. Two attribute objects
/// have the same in-core value if each respective attribute has the same
/// in-core value.
/// Return `true` if the specified `lhs` and `rhs` attribute objects have the
/// same (in-core) value, and `false` otherwise. Two attribute objects have
/// the same in-core value if each respective attribute has the same in-core
/// value.
bool operator==(const FileCleanerConfiguration& lhs,
const FileCleanerConfiguration& rhs);

Expand All @@ -222,9 +220,8 @@ bool operator==(const FileCleanerConfiguration& lhs,
bool operator!=(const FileCleanerConfiguration& lhs,
const FileCleanerConfiguration& rhs);

/// Write a reasonable representation of the specified `configuration`
/// object to the specified output `stream`, and return a reference to
/// `stream`.
/// Write a reasonable representation of the specified `configuration` object
/// to the specified output `stream`, and return a reference to `stream`.
bsl::ostream& operator<<(bsl::ostream& stream,
const FileCleanerConfiguration& configuration);

Expand Down
4 changes: 2 additions & 2 deletions groups/bal/balber/balber_beruniversaltagnumber.h
View file
Original file line number Diff line number Diff line change
Expand Up @@ -218,7 +218,7 @@ struct BerUniversalTagNumber {
/// `alternateTag` any alternative tag numbers corresponding to
/// `object`. The behavior is undefined if the type category of
/// `object` and the `formattingMode` does not permit a universal tag
/// number (see {DESCRIPTION} for allowed type categories and formatting
/// number (see [](#DESCRIPTION) for allowed type categories and formatting
/// modes). Note that if an alternate tag number does not exist for
/// `object` then `alternateTag` is not modified.
template <typename TYPE>
Expand All @@ -230,7 +230,7 @@ struct BerUniversalTagNumber {
/// specified `formattingMode` using the specified `options`. The
/// behavior is undefined if the type category of `object` and the
/// `formattingMode` do not permit a universal tag number (see
/// {DESCRIPTION} for allowed type categories and formatting modes).
/// [](#DESCRIPTION) for allowed type categories and formatting modes).
template <typename TYPE>
static Value select(const TYPE& object,
int formattingMode,
Expand Down
96 changes: 48 additions & 48 deletions groups/bal/balcl/doc/balcl.txt
View file
Original file line number Diff line number Diff line change
Expand Up @@ -4,69 +4,69 @@

@MNEMONIC: Basic Application Library Command Line (balcl)

@DESCRIPTION: The 'balcl' package provides a set of components that enable
@DESCRIPTION: The `balcl` package provides a set of components that enable
users to access information from the process's command line via a
value-semantic class, 'balcl::CommandLine'. An {Overview} is provided below.
Full details can be found in the documentation of {'balcl_commandline'} and
value-semantic class, `balcl::CommandLine`.
Full details can be found in the documentation of `balcl_commandline` and
the other components of this package.

/Overview
/--------
There are several steps to using 'balcl::CommandLine':
There are several steps to using `balcl::CommandLine`:

: 1 Specify the set of command-line options (and their attributes) that are
: allowed on the command line by creation of a table of 'balcl::OptionInfo'
: or 'balcl::Option' objects. See {Option Attributes} below.
:
: 2 Create a 'balcl::CommandLine' object from the command-line-option
: specification table.
:
: 3 Pass command-line information (i.e., 'argv') to the 'parse' method of the
: 'balcl::CommandLine' object.
:
: 4 If the 'parse' method is successful, use 'balcl::CommandLine' accessors or
: the accessors of a returned 'balcl::CommandLineOptionsHandle' object. Note
: that options that were defined by the user but did not appear in the
: command line (i.e., the input to 'parse') are left in a "null" state unless
: the user also defined a default value for the option (see {Option
: Attributes}).
1. Specify the set of command-line options (and their attributes) that are
allowed on the command line by creation of a table of `balcl::OptionInfo`
or `balcl::Option` objects. See {Option Attributes} below.

2. Create a `balcl::CommandLine` object from the command-line-option
specification table.

3. Pass command-line information (i.e., `argv`) to the `parse` method of the
`balcl::CommandLine` object.

4. If the `parse` method is successful, use `balcl::CommandLine` accessors or
the accessors of a returned `balcl::CommandLineOptionsHandle` object. Note
that options that were defined by the user but did not appear in the
command line (i.e., the input to `parse`) are left in a "null" state unless
the user also defined a default value for the option (see
[](#Option Attributes)).

/Option Attributes
/-----------------
This package provides a rich set of features for users to define their
allowed options. These include:

: o The names by which the option can be specified on the command line (a long
: tag name and, optionally, a short tag name) as well as a separate name by
: which, after a successful parse, the value of the option can be
: programmatically accessed.
:
: o A description that is later used by the 'printUsage' method.
:
: o Whether or not the option must appear on the command line for a successful
: parse.
:
: o Whether or not the option description will be included in the output
: of the 'printUsage' method.
:
: o Is the option a simple "flag" (a boolean option, either present on the
: command line or not) or does the option have a value?
:
: o If the option has a value, the user can specify:
: o The type of the option value.
: o Whether the option value is scalar or an array.
: o Optionally: A default value for the option.
: o Optionally: A user-supplied functor (a "constraint") to validate the
: value.
:
: o Optionally, the user can supply the address of a variable that is "linked"
: to the option. If so, after a successful parse, the option value can be
: obtained from the variable (an alternative to using the
: 'balcl::CommandLine' accessors).
* The names by which the option can be specified on the command line (a long
tag name and, optionally, a short tag name) as well as a separate name by
which, after a successful parse, the value of the option can be
programmatically accessed.

* A description that is later used by the `printUsage` method.

* Whether or not the option must appear on the command line for a successful
parse.

* Whether or not the option description will be included in the output
of the `printUsage` method.

* Is the option a simple "flag" (a boolean option, either present on the
command line or not) or does the option have a value?

* If the option has a value, the user can specify:
- The type of the option value.
- Whether the option value is scalar or an array.
- Optionally: A default value for the option.
- Optionally: A user-supplied functor (a "constraint") to validate the
value.

* Optionally, the user can supply the address of a variable that is "linked"
to the option. If so, after a successful parse, the option value can be
obtained from the variable (an alternative to using the
`balcl::CommandLine` accessors).

/Hierarchical Synopsis
/---------------------
The 'balcl' package currently has 8 components having 6 levels of physical
The `balcl` package currently has 8 components having 6 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.
Expand Down
Loading

0 comments on commit 957c036

Please sign in to comment.