Fix compiler-generated method's docs

groups/bal/balber/balber_berdecoderoptions.h

@@ -169,16 +169,17 @@ class BerDecoderOptions {
     /// value.
     BerDecoderOptions();
 
+    /// Create a 'BderDecoderOptons' object having the same value as the
+    /// specified 'original'.
     //! BerDecoderOptions(const BerDecoderOptions& original) = default;
-        // Create a 'BderDecoderOptons' object having the same value as the
-        // specified 'original'.
 
+    /// Destroy this object.
     //! ~BerDecoderOptions() = default;
-        // Destroy this object.
 
     // MANIPULATORS
+
+    /// Assign to this object the value of the specified 'rhs' object.
     //! BerDecoderOptions& operator=(const BerDecoderOptions& rhs) = default;
-        // Assign to this object the value of the specified 'rhs' object.
 
     /// Assign to this object the value read from the specified input
     /// `stream` using the specified `version` format, and return a

groups/bal/balber/balber_berutil.h

@@ -259,8 +259,8 @@ struct BerUtil {
                         const BerEncoderOptions *options = 0);
 };
 
-///Implementation Note
-///-------------------
+// Implementation Note
+// -------------------
 // The following utility structs used in the implementation of 'BerUtil' are
 // provided in reverse dependency order.  This means that low-level utilities
 // appear first, and higher-level utilities later.  No utility uses another
@@ -1501,19 +1501,20 @@ class BerUtil_DateAndTimeHeader {
     /// `timezoneOffsetInMinutes` attribute with the 0 value.
     BerUtil_DateAndTimeHeader();
 
+    /// Create a 'BerUtil_DateAndTimeHeader' object having the same value as
+    /// the specified 'original' object.
     //! BerUtil_DateAndTimeHeader(
-        //!               const BerUtil_DateAndTimeHeader& original) = default;
-        // Create a 'BerUtil_DateAndTimeHeader' object having the same value as
-        // the specified 'original' object.
+    //!                   const BerUtil_DateAndTimeHeader& original) = default;
 
+    /// Destroy this object.
     //! ~BerUtil_DateAndTimeHeader() = default;
-        // Destroy this object.
 
     // MANIPULATORS
+
+    /// Assign to this object the value of the specified 'rhs' object, and
+    /// return a non-'const' reference to this object.
     //! BerUtil_DateAndTimeHeader&
-        //!          operator=(const BerUtil_DateAndTimeHeader& rhs) = default;
-        // Assign to this object the value of the specified 'rhs' object, and
-        // return a non-'const' reference to this object.
+    //!              operator=(const BerUtil_DateAndTimeHeader& rhs) = default;
 
     /// Set the `type` attribute of this object to the
     /// `Type::e_NOT_EXTENDED_BINARY` value and the

groups/bal/balcl/balcl_optionvalue.h

@@ -487,8 +487,8 @@ class OptionValue {
     OptionValue(const OptionValue&  original,
                 bslma::Allocator   *basicAllocator = 0);
 
+    /// Destroy this object.
     //! ~OptionValue() = default;
-        // Destroy this object.
 
     // MANIPULATORS
 

groups/bal/baljsn/baljsn_encoder.h

@@ -201,8 +201,8 @@ class Encoder {
     /// default allocator is used.
     explicit Encoder(bslma::Allocator *basicAllocator = 0);
 
+    /// Destroy this object.
     //! ~Encoder() = default;
-        // Destroy this object.
 
     // MANIPULATORS
 

groups/bal/baljsn/baljsn_formatter.h

@@ -268,8 +268,8 @@ class Formatter {
               int               spacesPerLevel     = 0,
               bslma::Allocator *basicAllocator     = 0);
 
+    /// Destroy this object.
     //! ~Formatter() = default;
-        // Destroy this object.
 
     // MANIPULATORS
 

groups/bal/ball/ball_attributecontainerlist.h

@@ -150,7 +150,7 @@ class AttributeContainerListIterator {
 
     /// Destroy this iterator.  Note that this trivial destructor is
     /// generated by the compiler.
-    // ~AttributeContainerListIterator();
+    //! ~AttributeContainerListIterator();
 
     // MANIPULATORS
 

groups/bal/ball/ball_attributecontext.h

@@ -368,7 +368,7 @@ class AttributeContext_RuleEvaluationCache {
 
     /// Destroy this rule evaluation cache.  Note that this trivial
     /// destructor is generated by the compiler.
-    // ~AttributeContext_RuleEvaluationCache();
+    //! ~AttributeContext_RuleEvaluationCache();
 
     // MANIPULATORS
 

groups/bal/ball/ball_context.h

@@ -305,7 +305,7 @@ class Context {
 
     /// Destroy this context object.  Note that this trivial destructor is
     /// generated by the compiler.
-    // ~Context();
+    //! ~Context();
 
     // MANIPULATORS
 

groups/bal/ball/ball_thresholdaggregate.h

@@ -109,9 +109,8 @@ class ThresholdAggregate {
     /// specified `original` threshold aggregate.
     ThresholdAggregate(const ThresholdAggregate& original);
 
-    // ~ThresholdAggregate();
-        // Destroy this threshold aggregate.  Note that this trivial destructor
-        // is generated by the compiler.
+    /// Destroy this object.
+    //! ~ThresholdAggregate();
 
     // MANIPULATORS
 

groups/bal/balm/balm_integermetric.h

@@ -284,9 +284,8 @@ class IntegerMetric {
     /// similarly be inactive.
     IntegerMetric(const IntegerMetric& original);
 
-    // ~IntegerMetric();
-        // Destroy this integer metric.  Note that this trivial destructor is
-        // generated by the compiler.
+    /// Destroy this object.
+    //! ~IntegerMetric() = default;
 
     // MANIPULATORS
 
@@ -352,17 +351,17 @@ class IntegerMetric {
 // FREE OPERATORS
 
 /// Return `true` if the specified `lhs` and `rhs` integer metrics have the
-/// same value and `false` otherwise.  Two integer metrics have the same
-/// value if they record measurements using the same integer collector
-/// object or if they both have null collectors (i.e., `collector()` is 0).
+/// same value and `false` otherwise.  Two integer metrics have the same value
+/// if they record measurements using the same integer collector object or if
+/// they both have null collectors (i.e., `collector()` is 0).
 inline
 bool operator==(const IntegerMetric& lhs, const IntegerMetric& rhs);
 
-/// Return `true` if the specified `lhs` and `rhs` integer metrics do not
-/// have the same value and `false` otherwise.  Two integer metrics do not
-/// have the same value if they record measurements using different integer
-/// collector objects or if one, but not both, have a null collector (i.e.,
-/// `collector()` is 0).
+/// Return `true` if the specified `lhs` and `rhs` integer metrics do not have
+/// the same value and `false` otherwise.  Two integer metrics do not have the
+/// same value if they record measurements using different integer collector
+/// objects or if one, but not both, have a null collector (i.e., `collector()`
+/// is 0).
 inline
 bool operator!=(const IntegerMetric& lhs, const IntegerMetric& rhs);
 
@@ -373,7 +372,7 @@ bool operator!=(const IntegerMetric& lhs, const IntegerMetric& rhs);
 /// This structure provides a namespace for functions used to implement the
 /// macros defined by this component.
 ///
-/// This is an implementation type of this component and *must* *not* be
+/// This is an implementation type of this component and **must not** be
 /// used by clients of the `balm` package.
 struct IntegerMetric_MacroImp {
 
@@ -383,7 +382,7 @@ struct IntegerMetric_MacroImp {
     /// integer collector (from the default metrics manager) for the
     /// specified `metric` identified by the specified `category` and
     /// `name`, and register the specified `holder` for `category`.   Note
-    /// that `*collector` must be assigned *before* registering `holder` to
+    /// that `*collector` must be assigned **before** registering `holder` to
     /// ensure that the macros always have a valid `collector` when
     /// `holder->enabled()` is `true`.
     static void getCollector(IntegerCollector **collector,

groups/bal/balm/balm_metric.h

@@ -274,9 +274,8 @@ class Metric {
     /// inactive.
     Metric(const Metric& original);
 
-    // ~Metric();
-        // Destroy this metric.  Note that this trivial destructor is generated
-        // by the compiler.
+    /// Destroy this object.
+    //! ~Metric();
 
     // MANIPULATORS
 

groups/bal/balm/balm_metricdescription.h

@@ -157,9 +157,8 @@ class MetricDescription {
                       const char       *name,
                       bslma::Allocator *basicAllocator = 0);
 
-    // ~MetricDescription();
-        // Destroy this metric description.  Note that this trivial destructor
-        // is generated by the compiler.
+    /// Destroy this object
+    //! ~MetricDescription() = default;
 
     // MANIPULATORS
 

groups/bal/balm/balm_metricformat.h

@@ -178,9 +178,8 @@ class MetricFormatSpec {
     /// this object.
     MetricFormatSpec(const MetricFormatSpec& original);
 
-    // ~MetricFormatSpec();
-        // Destroy this format spec.  Note that this trivial destructor is
-        // generated by the compiler.
+    /// Destroy this object.
+    //! ~MetricFormatSpec();
 
     // MANIPULATORS
 
@@ -230,18 +229,18 @@ class MetricFormatSpec {
 
 // FREE OPERATORS
 
-/// Return `true` if the specified `lhs` and `rhs` metric format specs have
-/// the same value, and `false` otherwise.  Two format specs have the same
-/// value if they have the same values for their `scale` and `format`
-/// attributes, respectively.
+/// Return `true` if the specified `lhs` and `rhs` metric format specs have the
+/// same value, and `false` otherwise.  Two format specs have the same value if
+/// they have the same values for their `scale` and `format` attributes,
+/// respectively.
 inline
 bool operator==(const MetricFormatSpec& lhs,
                 const MetricFormatSpec& rhs);
 
-/// Return `true` if the specified `lhs` and `rhs` metric format specs do
-/// not have the same value, and `false` otherwise.  Two format specs do
-/// not have same value if they differ in their respective values for
-/// `scale` or `format` attributes.
+/// Return `true` if the specified `lhs` and `rhs` metric format specs do not
+/// have the same value, and `false` otherwise.  Two format specs do not have
+/// same value if they differ in their respective values for `scale` or
+/// `format` attributes.
 inline
 bool operator!=(const MetricFormatSpec& lhs,
                 const MetricFormatSpec& rhs);
@@ -303,9 +302,8 @@ class MetricFormat {
     MetricFormat(const MetricFormat&  original,
                  bslma::Allocator    *basicAllocator = 0);
 
-    // ~MetricFormat();
-        // Destroy this metric format object.  Note that this trivial
-        // destructor is generated by the compiler.
+    /// Destroy this object.
+    //! ~MetricFormat() = default;
 
     // MANIPULATORS
 

groups/bal/balm/balm_metricid.h

@@ -134,23 +134,23 @@ class MetricId {
     /// lifetime of this metric id object.
     MetricId(const MetricDescription *metricDescription);
 
-    // MetricId(const MetricId& original) = default;
-        // Create a metric id with the value of the specified 'original'
-        // metric id.  The behavior is undefined unless the 'description()' of
-        // 'original' is 0, or the indicated metric description object remains
-        // valid for the lifetime of this metric id object.
+    /// Create a metric id with the value of the specified 'original' metric
+    /// id.  The behavior is undefined unless the 'description()' of 'original'
+    /// is 0, or the indicated metric description object remains valid for the
+    /// lifetime of this metric id object.
+    //! MetricId(const MetricId& original) = default;
 
-    // ~MetricId();
-        // Destroy this metric id.  Note that this trivial destructor is
-        // generated by the compiler.
+    /// Destroy this object.
+    //! ~MetricId() = default;
 
     // MANIPULATORS
-    // MetricId& operator=(const MetricId& rhs) = default;
-        // Assign this metric id the value of the specified 'rhs' metric id
-        // object, and return a reference to this object.  The behavior is
-        // undefined unless the 'description()' of 'rhs' is 0, or the
-        // metric-description object remains valid for the lifetime of this
-        // metric-id object.
+
+    /// Assign this metric id the value of the specified 'rhs' metric id
+    /// object, and return a reference to this object.  The behavior is
+    /// undefined unless the 'description()' of 'rhs' is 0, or the
+    /// metric-description object remains valid for the lifetime of this
+    /// metric-id object.
+    //! MetricId& operator=(const MetricId& rhs) = default;
 
     /// Return a reference to the modifiable address of the *held*
     /// non-modifiable `MetricDescription`, which defines the value of this

groups/bal/balm/balm_metricrecord.h

@@ -219,18 +219,18 @@ class MetricRecord {
                  double          min,
                  double          max);
 
-    // MetricRecord(const MetricRecord& original) = default;
-        // Create a metric record having the value of the specified 'original'
-        // record.
+    /// Create a metric record having the value of the specified 'original'
+    /// record.
+    //! MetricRecord(const MetricRecord& original) = default;
 
-    // ~MetricRecord();
-        // Destroy this object.  Note that this trivial destructor is generated
-        // by the compiler.
+    /// Destroy this object.
+    //! ~MetricRecord() = default;
 
     // MANIPULATORS
-    // MetricRecord& operator=(const MetricRecord& rhs) = default;
-        // Assign to this metric record the value of the specified 'rhs'
-        // record, and return a reference to this modifiable record.
+
+    /// Assign to this metric record the value of the specified 'rhs' record,
+    /// and return a reference to this modifiable record.
+    //! MetricRecord& operator=(const MetricRecord& rhs) = default;
 
     /// Return a reference to the modifiable `metricId` attribute
     /// representing the identifier for the metric being recorded.

groups/bal/balm/balm_metricsample.h

@@ -191,9 +191,8 @@ class MetricSampleGroup {
     /// specified `original` sample group.
     MetricSampleGroup(const MetricSampleGroup& original);
 
-    // ~MetricSampleGroup();
-        // Destroy this sample group.  Note that this trivial destructor is
-        // generated by the compiler.
+    /// Destroy this object.
+    //! ~MetricSampleGroup() = default;
 
     // MANIPULATORS