Skip to content

Commit

Permalink
Cleanup documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
@osubboo
osubboo committed Nov 6, 2024
1 parent fc82e28 commit c34fde5
Show file tree
Hide file tree
Showing 8 changed files with 97 additions and 96 deletions.
8 changes: 4 additions & 4 deletions groups/bdl/bdlb/bdlb_nullablevalueref.h
View file
Original file line number Diff line number Diff line change
Expand Up @@ -329,19 +329,19 @@ class NullableValueRef {
TYPE& makeValueInplace(ARGS&&... args);
#endif

BSLS_DEPRECATE_FEATURE("bdl", "NullableValueRef::valueOr",
"Use 'value_or' instead")
/// Return the value of the underlying object of a (template parameter)
/// `TYPE` if this object is non-null, and the specified `otherValue`
/// otherwise. Note that this method returns *by* *value*, so may be
/// inefficient in some contexts.
BSLS_DEPRECATE_FEATURE("bdl", "NullableValueRef::valueOr",
"Use 'value_or' instead")
TYPE valueOr(const TYPE& otherValue) const;

BSLS_DEPRECATE_FEATURE("bdl", "NullableValueRef::valueOrNull",
"Use 'has_value() ? &value() : NULL' instead")
/// Return an address providing non-modifiable access to the underlying
/// object of a (template parameter) `TYPE` if this object is non-null,
/// and 0 otherwise.
BSLS_DEPRECATE_FEATURE("bdl", "NullableValueRef::valueOrNull",
"Use 'has_value() ? &value() : NULL' instead")
const TYPE *valueOrNull() const;
};

Expand Down
10 changes: 5 additions & 5 deletions groups/bdl/bdlb/bdlb_nullablevalueref_cpp03.h
View file
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,7 @@
// regions of C++11 code, then this header contains no code and is not
// '#include'd in the original header.
//
// Generated on Wed Sep 4 19:02:35 2024
// Generated on Wed Nov 6 15:09:19 2024
// Command line: sim_cpp11_features.pl bdlb_nullablevalueref.h

#ifdef COMPILING_BDLB_NULLABLEVALUEREF_H
Expand Down Expand Up @@ -368,19 +368,19 @@ class NullableValueRef {
// }}} END GENERATED CODE
#endif

BSLS_DEPRECATE_FEATURE("bdl", "NullableValueRef::valueOr",
"Use 'value_or' instead")
/// Return the value of the underlying object of a (template parameter)
/// `TYPE` if this object is non-null, and the specified `otherValue`
/// otherwise. Note that this method returns *by* *value*, so may be
/// inefficient in some contexts.
BSLS_DEPRECATE_FEATURE("bdl", "NullableValueRef::valueOr",
"Use 'value_or' instead")
TYPE valueOr(const TYPE& otherValue) const;

BSLS_DEPRECATE_FEATURE("bdl", "NullableValueRef::valueOrNull",
"Use 'has_value() ? &value() : NULL' instead")
/// Return an address providing non-modifiable access to the underlying
/// object of a (template parameter) `TYPE` if this object is non-null,
/// and 0 otherwise.
BSLS_DEPRECATE_FEATURE("bdl", "NullableValueRef::valueOrNull",
"Use 'has_value() ? &value() : NULL' instead")
const TYPE *valueOrNull() const;
};

Expand Down
6 changes: 2 additions & 4 deletions groups/bdl/bdlcc/bdlcc_objectcatalog.h
View file
Original file line number Diff line number Diff line change
Expand Up @@ -11,8 +11,6 @@ BSLS_IDENT("$Id: $")
// bdlcc::ObjectCatalog: templatized, thread-safe, indexed object container
// bdlcc::ObjectCatalogIter: thread-safe iterator for `bdlcc::ObjectCatalog`
//
//@SEE_ALSO:
//
//@DESCRIPTION: This component provides a thread-safe and efficient templatized
// catalog of objects. A `bdlcc::ObjectCatalog` supports efficient insertion
// of objects through the `add` method, which returns a handle that can be used
Expand Down Expand Up @@ -515,14 +513,14 @@ class ObjectCatalog {
/// this catalog.
int length() const;

BSLS_DEPRECATE_FEATURE("bde", "ObjectCataloog::value(handle)",
"use 'ObjectCatalogIter::value()' instead")
/// Return a `const` reference to the object having the specified
/// `handle`. The behavior is undefined unless `handle` is contained in
/// this catalog.
///
/// This method is *DEPRECATED* because it is not thread-safe. Use
/// `find`, `isMember`, or access the object through an iterator.
BSLS_DEPRECATE_FEATURE("bde", "ObjectCataloog::value(handle)",
"use 'ObjectCatalogIter::value()' instead")
const TYPE& value(int handle) const;

// FOR TESTING PURPOSES ONLY
Expand Down
4 changes: 2 additions & 2 deletions groups/bdl/bdlde/bdlde_base64decoder.h
View file
Original file line number Diff line number Diff line change
Expand Up @@ -547,7 +547,6 @@ class Base64Decoder {
explicit
Base64Decoder(const Base64DecoderOptions& options);

BSLS_DEPRECATE_FEATURE("bdl", "Base64Decoder", "use options c'tor")
/// Create a Base64 decoder in the initial state. Unrecognized
/// characters (i.e., non-base64 characters other than whitespace) will
/// be treated as errors if the specified
Expand All @@ -557,6 +556,7 @@ class Base64Decoder {
/// alphabet, "base64", is used. Padded input is assumed.
///
/// @DEPRECATED: Use the overload that takes `options` instead.
BSLS_DEPRECATE_FEATURE("bdl", "Base64Decoder", "use options c'tor")
explicit
Base64Decoder(bool unrecognizedNonWhitespaceIsErrorFlag,
Alphabet alphabet = e_BASIC);
Expand Down Expand Up @@ -661,13 +661,13 @@ class Base64Decoder {
/// `false` otherwise.
bool isPadded() const;

BSLS_DEPRECATE_FEATURE("bdl", "isUnrecognizedAnError", "use ignoreMode")
/// Return `true` if this mechanism is currently configured to report an
/// error when an unrecognized character (i.e., a character other than
/// one of the 64 "numeric" base-64 characters, `=`, or whitespace) is
/// encountered, and `false` otherwise.
///
/// @DEPRECATED: use the `ignoreMode` accessor instead.
BSLS_DEPRECATE_FEATURE("bdl", "isUnrecognizedAnError", "use ignoreMode")
bool isUnrecognizedAnError() const;

/// Return a `Base64DecoderOptions` object representing the
Expand Down
36 changes: 18 additions & 18 deletions groups/bdl/bdlde/bdlde_base64encoder.h
View file
Original file line number Diff line number Diff line change
Expand Up @@ -538,9 +538,6 @@ class Base64Encoder {
static bsl::size_t encodedLength(const EncoderOptions& options,
bsl::size_t inputLength);

BSLS_DEPRECATE_FEATURE("bdl",
"encodedLength",
"use overload with 'options'")
/// Return the exact number of encoded bytes that would result from an
/// input byte sequence of the specified `inputLength` provided to the
/// `convert` method of an encoder with the maximum allowable
Expand All @@ -549,12 +546,12 @@ class Base64Encoder {
/// `0 <= inputLength`.
///
/// @DEPRECATED: use the overload with `options` instead.
static
int encodedLength(int inputLength);

BSLS_DEPRECATE_FEATURE("bdl",
"encodedLength",
"use overload with 'options'")
static
int encodedLength(int inputLength);

/// Return the exact number of encoded bytes that would result from an
/// input byte sequence of the specified `inputLength` provided to the
/// `convert` method of an encoder configured with the specified
Expand All @@ -565,6 +562,9 @@ class Base64Encoder {
/// *output* bytes.
///
/// @DEPRECATED: use the overload with `options` instead.
BSLS_DEPRECATE_FEATURE("bdl",
"encodedLength",
"use overload with 'options'")
static
int encodedLength(int inputLength, int maxLineLength);

Expand All @@ -576,9 +576,6 @@ class Base64Encoder {
static bsl::size_t encodedLines(const EncoderOptions& options,
bsl::size_t inputLength);

BSLS_DEPRECATE_FEATURE("bdl",
"encodedLines",
"use overload with 'options'")
/// Return the exact number of encoded lines that would result from an
/// input byte sequence of the specified `inputLength` provided to the
/// `convert` method of an encoder with the maximum allowable
Expand All @@ -588,12 +585,12 @@ class Base64Encoder {
/// not be the number of *output* bytes.
///
/// @DEPRECATED: use the overload with `options` instead.
static
int encodedLines(int inputLength);

BSLS_DEPRECATE_FEATURE("bdl",
"encodedLines",
"use overload with 'options'")
static
int encodedLines(int inputLength);

/// Return the exact number of encoded lines that would result from an
/// input byte sequence of the specified `inputLength` provided to the
/// `convert` method of an encoder configured with the specified
Expand All @@ -604,6 +601,9 @@ class Base64Encoder {
/// *output* bytes.
///
/// @DEPRECATED: use the overload with `options` instead.
BSLS_DEPRECATE_FEATURE("bdl",
"encodedLines",
"use overload with 'options'")
static
int encodedLines(int inputLength, int maxLineLength);

Expand All @@ -615,9 +615,6 @@ class Base64Encoder {
explicit
Base64Encoder(const EncoderOptions& options = EncoderOptions::mime());

BSLS_DEPRECATE_FEATURE("bdl",
"Base64Encoder",
"use overload with 'options'")
/// Create a Base64 encoder in the initial state, defaulting the maximum
/// allowable line-length of the output to 76 (as recommended by the
/// MIME standard). Optionally specify an alphabet used to encode
Expand All @@ -627,12 +624,12 @@ class Base64Encoder {
/// each line of the output from exceeding 76 characters.
///
/// @DEPRECATED: Create and pass an `options` object instead.
explicit
Base64Encoder(Alphabet alphabet);

BSLS_DEPRECATE_FEATURE("bdl",
"Base64Encoder",
"use overload with 'options'")
explicit
Base64Encoder(Alphabet alphabet);

/// Create a Base64 encoder in the initial state, setting the maximum
/// allowable line-length of the output to the specified
/// `maxLineLength`. Specifying 0 for `maxLineLength` will result in a
Expand All @@ -645,6 +642,9 @@ class Base64Encoder {
/// output from exceeding `maxLineLength`.
///
/// @DEPRECATED: Create and pass an `options` object instead.
BSLS_DEPRECATE_FEATURE("bdl",
"Base64Encoder",
"use overload with 'options'")
explicit
Base64Encoder(int maxLineLength, Alphabet alphabet = e_BASIC);

Expand Down
65 changes: 33 additions & 32 deletions groups/bdl/bdlt/bdlt_iso8601util.h
View file
Original file line number Diff line number Diff line change
Expand Up @@ -1617,10 +1617,7 @@ struct Iso8601Util {

#ifndef BDE_OMIT_INTERNAL_DEPRECATED
// DEPRECATED METHODS
BDLT_ISO8601UTIL_DEPRECATE_PARSERELAXED
/// **DEPRECATED**: Use `parse` with `configuration.relaxed() == true`
/// instead.
///

/// Parse the specified initial `length` characters of the specified
/// "relaxed" ISO 8601 `string` as a `Datetime` value, and load the
/// value into the specified `result`. Return 0 on success, and a
Expand All @@ -1646,14 +1643,14 @@ struct Iso8601Util {
/// "24:00:00", then the fractional second must be absent or 0, and the
/// zone designator must be absent or indicate UTC. The behavior is
/// undefined unless `0 <= length`.
///
/// @DEPRECATED: Use `parse` with `configuration.relaxed() == true`
/// instead.
BDLT_ISO8601UTIL_DEPRECATE_PARSERELAXED
static int parseRelaxed(Datetime *result,
const char *string,
ssize_t length);

BDLT_ISO8601UTIL_DEPRECATE_PARSERELAXED
/// **DEPRECATED**: Use `parse` with `configuration.relaxed() == true`
/// instead.
///
/// Parse the specified initial `length` characters of the specified
/// "relaxed" ISO 8601 `string` as a `DatetimeTz` value, and load the
/// value into the specified `result`. Return 0 on success, and a
Expand All @@ -1677,14 +1674,14 @@ struct Iso8601Util {
/// "hh:mm:ss" portion of `string` is "24:00:00", then the fractional
/// second must be absent or 0, and the zone designator must be absent
/// or indicate UTC. The behavior is undefined unless `0 <= length`.
///
/// @DEPRECATED: Use `parse` with `configuration.relaxed() == true`
/// instead.
BDLT_ISO8601UTIL_DEPRECATE_PARSERELAXED
static int parseRelaxed(DatetimeTz *result,
const char *string,
ssize_t length);

BDLT_ISO8601UTIL_DEPRECATE_PARSERELAXED
/// **DEPRECATED**: Use `parse` with `configuration.relaxed() == true`
/// instead.
///
/// Parse the specified initial `length` characters of the specified
/// "relaxed" ISO 8601 `string` as a `Datetime` or `DatetimeTz` value,
/// depending on the presence of a zone designator, and load the value
Expand All @@ -1710,14 +1707,14 @@ struct Iso8601Util {
/// "hh:mm:ss" portion of `string` is "24:00:00", then the fractional
/// second must be absent or 0, and the zone designator must be absent
/// or indicate UTC. The behavior is undefined unless `0 <= length`.
///
/// @DEPRECATED: Use `parse` with `configuration.relaxed() == true`
/// instead.
BDLT_ISO8601UTIL_DEPRECATE_PARSERELAXED
static int parseRelaxed(DatetimeOrDatetimeTz *result,
const char *string,
ssize_t length);

BDLT_ISO8601UTIL_DEPRECATE_PARSERELAXED
/// **DEPRECATED**: Use `parse` with `configuration.relaxed() == true`
/// instead.
///
/// Parse the specified "relaxed" ISO 8601 `string` as a `Datetime`
/// value, and load the value into the specified `result`. Return 0 on
/// success, and a non-zero value (with no effect) otherwise. `string`
Expand All @@ -1743,12 +1740,12 @@ struct Iso8601Util {
/// second must be absent or 0, and the zone designator must be absent
/// or indicate UTC. The behavior is undefined unless `string.data()`
/// is non-null.
///
/// @DEPRECATED: Use `parse` with `configuration.relaxed() == true`
/// instead.
BDLT_ISO8601UTIL_DEPRECATE_PARSERELAXED
static int parseRelaxed(Datetime *result, const bsl::string_view& string);

BDLT_ISO8601UTIL_DEPRECATE_PARSERELAXED
/// **DEPRECATED**: Use `parse` with `configuration.relaxed() == true`
/// instead.
///
/// Parse the specified "relaxed" ISO 8601 `string` as a `DatetimeTz`
/// value, and load the value into the specified `result`. Return 0 on
/// success, and a non-zero value (with no effect) otherwise. `string`
Expand All @@ -1772,13 +1769,13 @@ struct Iso8601Util {
/// "24:00:00", then the fractional second must be absent or 0, and the
/// zone designator must be absent or indicate UTC. The behavior is
/// undefined unless `string.data()` is non-null.
///
/// @DEPRECATED: Use `parse` with `configuration.relaxed() == true`
/// instead.
BDLT_ISO8601UTIL_DEPRECATE_PARSERELAXED
static int parseRelaxed(DatetimeTz *result,
const bsl::string_view& string);

BDLT_ISO8601UTIL_DEPRECATE_PARSERELAXED
/// **DEPRECATED**: Use `parse` with `configuration.relaxed() == true`
/// instead.
///
/// Parse the specified "relaxed" ISO 8601 `string` as a `Datetime` or
/// `DatetimeTz` value, depending on the presence of a zone designator,
/// and load the value into the specified `result`. Return 0 on
Expand All @@ -1804,9 +1801,15 @@ struct Iso8601Util {
/// "24:00:00", then the fractional second must be absent or 0, and the
/// zone designator must be absent or indicate UTC. The behavior is
/// undefined unless `string.data()` is non-null.
///
/// @DEPRECATED: Use `parse` with `configuration.relaxed() == true`
/// instead.
BDLT_ISO8601UTIL_DEPRECATE_PARSERELAXED
static int parseRelaxed(DatetimeOrDatetimeTz *result,
const bsl::string_view& string);

/// @DEPRECATED: Use the overloads taking the `bufferLength` argument
/// *before* the `object` argument instead.
BDLT_ISO8601UTIL_DEPRECATE_GENERATE_ORDER
static int generate(char *buffer,
const Date& object,
Expand All @@ -1828,12 +1831,12 @@ struct Iso8601Util {
const TimeTz& object,
ssize_t bufferLength);
BDLT_ISO8601UTIL_DEPRECATE_GENERATE_ORDER
/// **DEPRECATED**: Use the overloads taking the `bufferLength` argument
/// *before* the `object` argument instead.
static int generate(char *buffer,
const DatetimeTz& object,
ssize_t bufferLength);

/// @DEPRECATED: Use the overloads taking an `Iso8601UtilConfiguration`
/// object instead.
BDLT_ISO8601UTIL_DEPRECATE_GENERATE
static int generate(char *buffer,
const DateTz& object,
Expand All @@ -1845,13 +1848,13 @@ struct Iso8601Util {
ssize_t bufferLength,
bool useZAbbreviationForUtc);
BDLT_ISO8601UTIL_DEPRECATE_GENERATE
/// **DEPRECATED**: Use the overloads taking an `Iso8601UtilConfiguration`
/// object instead.
static int generate(char *buffer,
const DatetimeTz& object,
ssize_t bufferLength,
bool useZAbbreviationForUtc);

/// @DEPRECATED: Use the overloads taking an `Iso8601UtilConfiguration`
/// object instead.
BDLT_ISO8601UTIL_DEPRECATE_GENERATE
static bsl::ostream& generate(bsl::ostream& stream,
const DateTz& object,
Expand All @@ -1861,12 +1864,12 @@ struct Iso8601Util {
const TimeTz& object,
bool useZAbbreviationForUtc);
BDLT_ISO8601UTIL_DEPRECATE_GENERATE
/// **DEPRECATED**: Use the overloads taking an `Iso8601UtilConfiguration`
/// object instead.
static bsl::ostream& generate(bsl::ostream& stream,
const DatetimeTz& object,
bool useZAbbreviationForUtc);

/// @DEPRECATED: Use the overloads taking an `Iso8601UtilConfiguration`
/// object instead.
BDLT_ISO8601UTIL_DEPRECATE_GENERATERAW
static int generateRaw(char *buffer,
const DateTz& object,
Expand All @@ -1876,8 +1879,6 @@ struct Iso8601Util {
const TimeTz& object,
bool useZAbbreviationForUtc);
BDLT_ISO8601UTIL_DEPRECATE_GENERATERAW
/// **DEPRECATED**: Use the overloads taking an `Iso8601UtilConfiguration`
/// object instead.
static int generateRaw(char *buffer,
const DatetimeTz& object,
bool useZAbbreviationForUtc);
Expand Down
Loading

0 comments on commit c34fde5

Please sign in to comment.