Skip to content

Commit 6736a84

Browse files
committed
Cleanup documentation
1 parent 87462bb commit 6736a84

10 files changed

+187
-181
lines changed

groups/bdl/bdlb/bdlb_arrayutil.h

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -155,6 +155,7 @@ BSLS_IDENT("$Id: $")
155155
// 2. The sequences are compared using the `mismatch` algorithm: To get the
156156
// begin and of the `expect` array `bdlb::ArrayUtil::begin` and
157157
// `bdlb::ArrayUtil::end`, respectively, are used.
158+
//
158159
// ```
159160
// void getAndCheckData(bool verbose)
160161
// {

groups/bdl/bdlb/bdlb_chartype.h

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -293,9 +293,9 @@ BSLS_IDENT("$Id: $")
293293
// The first character is required and must be in category `ALUND`. All
294294
// subsequent characters are optional and must be in category `IDENT`:
295295
// ```
296+
// /// Return `true` if the specified `token` conforms to the requirements
297+
// /// of a C-style identifier, and `false` otherwise.
296298
// bool isIdentifier(const char *token)
297-
// // Return 'true' if the specified 'token' conforms to the requirements
298-
// // of a C-style identifier, and 'false' otherwise.
299299
// {
300300
// assert(token);
301301
//
@@ -319,8 +319,8 @@ BSLS_IDENT("$Id: $")
319319
// BDE_VERIFY pragma: -FABC01
320320

321321
namespace BloombergLP {
322-
323322
namespace bdlb {
323+
324324
/// This `struct` provides a namespace for a suite of pure procedures
325325
/// operating on the fundamental type `char`.
326326
struct CharType {

groups/bdl/bdlb/bdlb_hashutil.h

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -92,9 +92,9 @@ BSLS_IDENT("$Id: $")
9292
// public:
9393
// // CLASS METHODS
9494
//
95-
// // Return a hash value calculated from the specified `object` using
96-
// // the specified `size` as the number of slots. The hash value
97-
// // is guaranteed to be in the range [0, size).
95+
// /// Return a hash value calculated from the specified `object` using
96+
// /// the specified `size` as the number of slots. The hash value
97+
// /// is guaranteed to be in the range [0, size).
9898
// static int hash(const UserDefinedTickerType& object, int size);
9999
//
100100
// // Rest of the class definition omitted...
@@ -321,9 +321,9 @@ BSLS_IDENT("$Id: $")
321321
//
322322
// // CREATORS
323323
//
324-
// // Create a generator returning integers in a sequence starting at
325-
// // the optionally specified `first` integer, with the optionally
326-
// // specified `increment`.
324+
// /// Create a generator returning integers in a sequence starting at
325+
// /// the optionally specified `first` integer, with the optionally
326+
// /// specified `increment`.
327327
// explicit SequentialIntegers(int first = 1, int increment = 1)
328328
// : d_current(first), d_inc(increment) {}
329329
//

groups/bdl/bdlc/bdlc_bitarray.h

Lines changed: 43 additions & 40 deletions
Original file line numberDiff line numberDiff line change
@@ -131,14 +131,14 @@ BSLS_IDENT("$Id: $")
131131
//
132132
// First, we define the interface of `NullableVector`:
133133
// ```
134+
// /// This class implements a sequential container of elements of the
135+
// /// template parameter `TYPE`.
134136
// template <class TYPE>
135137
// class NullableVector {
136-
// // This class implements a sequential container of elements of the
137-
// // template parameter 'TYPE'.
138138
//
139139
// // DATA
140140
// bsl::vector<TYPE> d_values; // data elements
141-
// bdlc::BitArray d_nullFlags; // 'true' indicates i'th element is
141+
// bdlc::BitArray d_nullFlags; // `true` indicates i'th element is
142142
// // null
143143
//
144144
// private:
@@ -153,77 +153,80 @@ BSLS_IDENT("$Id: $")
153153
//
154154
// public:
155155
// // CREATORS
156+
//
157+
// /// Construct a vector having the specified `initialLength` null
158+
// /// elements. Optionally specify a `basicAllocator` used to supply
159+
// /// memory. If `basicAllocator` is 0, the currently supplied
160+
// /// default allocator is used.
156161
// explicit
157162
// NullableVector(bsl::size_t initialLength,
158163
// bslma::Allocator *basicAllocator = 0);
159-
// // Construct a vector having the specified 'initialLength' null
160-
// // elements. Optionally specify a 'basicAllocator' used to supply
161-
// // memory. If 'basicAllocator' is 0, the currently supplied
162-
// // default allocator is used.
163164
//
164165
// // ...
165166
//
166167
// ~NullableVector();
167168
// // Destroy this vector.
168169
//
169170
// // MANIPULATORS
171+
//
172+
// /// Append a null element to this vector. Note that the appended
173+
// /// element will have the same value as a default constructed `TYPE`
174+
// /// object.
170175
// void appendNullElement();
171-
// // Append a null element to this vector. Note that the appended
172-
// // element will have the same value as a default constructed 'TYPE'
173-
// // object.
174176
//
177+
// /// Append an element having the specified `value` to the end of
178+
// /// this vector.
175179
// void appendElement(const TYPE& value);
176-
// // Append an element having the specified 'value' to the end of
177-
// // this vector.
178180
//
181+
// /// Make the element at the specified `index` in this vector
182+
// /// non-null. The behavior is undefined unless `index < length()`.
179183
// void makeNonNull(bsl::size_t index);
180-
// // Make the element at the specified 'index' in this vector
181-
// // non-null. The behavior is undefined unless 'index < length()'.
182184
//
185+
// /// Make the element at the specified `index` in this vector null.
186+
// /// The behavior is undefined unless `index < length()`. Note that
187+
// /// the new value of the element will be the default constructed
188+
// /// value for `TYPE`.
183189
// void makeNull(bsl::size_t index);
184-
// // Make the element at the specified 'index' in this vector null.
185-
// // The behavior is undefined unless 'index < length()'. Note that
186-
// // the new value of the element will be the default constructed
187-
// // value for 'TYPE'.
188190
//
191+
// /// Return a reference providing modifiable access to the (valid)
192+
// /// element at the specified `index` in this vector. The behavior
193+
// /// is undefined unless `index < length()`. Note that if the
194+
// /// element at `index` is null then the nullness flag is reset and
195+
// /// the returned value is the default constructed value for `TYPE`.
189196
// TYPE& modifiableElement(bsl::size_t index);
190-
// // Return a reference providing modifiable access to the (valid)
191-
// // element at the specified 'index' in this vector. The behavior
192-
// // is undefined unless 'index < length()'. Note that if the
193-
// // element at 'index' is null then the nullness flag is reset and
194-
// // the returned value is the default constructed value for 'TYPE'.
195197
//
198+
// /// Remove the element at the specified `index` in this vector. The
199+
// /// behavior is undefined unless `index < length()`.
196200
// void removeElement(bsl::size_t index);
197-
// // Remove the element at the specified 'index' in this vector. The
198-
// // behavior is undefined unless 'index < length()'.
199201
//
200202
// // ACCESSORS
203+
//
204+
// /// Return a reference providing non-modifiable access to the
205+
// /// element at the specified `index` in this vector. The behavior
206+
// /// is undefined unless `index < length()`. Note that if the
207+
// /// element at `index` is null then the nullness flag is not reset
208+
// /// and the returned value is the default constructed value for
209+
// /// `TYPE`.
201210
// const TYPE& constElement(bsl::size_t index) const;
202-
// // Return a reference providing non-modifiable access to the
203-
// // element at the specified 'index' in this vector. The behavior
204-
// // is undefined unless 'index < length()'. Note that if the
205-
// // element at 'index' is null then the nullness flag is not reset
206-
// // and the returned value is the default constructed value for
207-
// // 'TYPE'.
208211
//
212+
// /// Return `true` if any element in this vector is non-null, and
213+
// /// `false` otherwise.
209214
// bool isAnyElementNonNull() const;
210-
// // Return 'true' if any element in this vector is non-null, and
211-
// // 'false' otherwise.
212215
//
216+
// /// Return `true` if any element in this vector is null, and `false`
217+
// /// otherwise.
213218
// bool isAnyElementNull() const;
214-
// // Return 'true' if any element in this vector is null, and 'false'
215-
// // otherwise.
216219
//
220+
// /// Return `true` if the element at the specified `index` in this
221+
// /// vector is null, and `false` otherwise. The behavior is
222+
// /// undefined unless `index < length()`.
217223
// bool isElementNull(bsl::size_t index) const;
218-
// // Return 'true' if the element at the specified 'index' in this
219-
// // vector is null, and 'false' otherwise. The behavior is
220-
// // undefined unless 'index < length()'.
221224
//
225+
// /// Return the number of elements in this vector.
222226
// bsl::size_t length() const;
223-
// // Return the number of elements in this vector.
224227
//
228+
// /// Return the number of null elements in this vector.
225229
// bsl::size_t numNullElements() const;
226-
// // Return the number of null elements in this vector.
227230
// };
228231
// ```
229232
// Then, we implement, in turn, each of the methods declared above:

0 commit comments

Comments
 (0)