Skip to content

Commit c6bb6a2

Browse files
authored
Clean up empty "Remarks" headings in standard library
1 parent 7bd2ed3 commit c6bb6a2

24 files changed

+0
-158
lines changed

docs/standard-library/allocators-functions.md

Lines changed: 0 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -72,8 +72,6 @@ Yields `stdext::allocators::cache_chunklist<sizeof(Type)>`.
7272
#define CACHE_CHUNKLIST <cache_class>
7373
```
7474

75-
### Remarks
76-
7775
## <a name="cache_freelist"></a> CACHE_FREELIST
7876

7977
Yields `stdext::allocators::cache_freelist<sizeof(Type), max>`.
@@ -82,8 +80,6 @@ Yields `stdext::allocators::cache_freelist<sizeof(Type), max>`.
8280
#define CACHE_FREELIST(max) <cache_class>
8381
```
8482
85-
### Remarks
86-
8783
## <a name="cache_suballoc"></a> CACHE_SUBALLOC
8884
8985
Yields `stdext::allocators::cache_suballoc<sizeof(Type)>`.
@@ -92,8 +88,6 @@ Yields `stdext::allocators::cache_suballoc<sizeof(Type)>`.
9288
#define CACHE_SUBALLOC <cache_class>
9389
```
9490

95-
### Remarks
96-
9791
## <a name="sync_default"></a> SYNC_DEFAULT
9892

9993
Yields a synchronization filter.

docs/standard-library/basic-string-class.md

Lines changed: 0 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -569,8 +569,6 @@ reference back();
569569

570570
A reference to the last element of the string, which must be non-empty.
571571

572-
### Remarks
573-
574572
## <a name="basic_string"></a> `basic_string::basic_string`
575573

576574
Constructs a string that is empty, initialized by specific characters, or is a copy of all or part of another string object or C style (null-terminated) string.
@@ -1473,8 +1471,6 @@ const_reverse_iterator crend() const;
14731471

14741472
A `const` reverse iterator that addresses the location succeeding the last element in a reversed string (the location that had preceded the first element in the unreversed string).
14751473

1476-
### Remarks
1477-
14781474
## <a name="copy_s"></a> `basic_string::_Copy_s`
14791475

14801476
Copies at most a specified number of characters from an indexed position in a source string to a target character array.
@@ -2885,8 +2881,6 @@ reference front();
28852881

28862882
A reference to the first element of the string, which must be non-empty.
28872883

2888-
### Remarks
2889-
28902884
## <a name="get_allocator"></a> `basic_string::get_allocator`
28912885

28922886
Returns a copy of the allocator object used to construct the string.

docs/standard-library/basic-stringbuf-class.md

Lines changed: 0 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -365,8 +365,6 @@ void basic_stringbuf<T>::swap(basic_stringbuf& other)
365365
*other*\
366366
The basic_stringbuf whose contents will be swapped with this basic_stringbuf.
367367

368-
### Remarks
369-
370368
## <a name="op_eq"></a> basic_stringbuf::operator=
371369

372370
Assigns the contents of the basic_stringbuf on the right side of the operator to the basic_stringbuf on the left side.
@@ -380,8 +378,6 @@ basic_stringbuf& basic_stringbuf:: operator=(const basic_stringbuf& other)
380378
*other*\
381379
A basic_stringbuf whose contents, including locale traits, will be assigned to the stringbuf on the left side of the operator.
382380

383-
### Remarks
384-
385381
## See also
386382

387383
[Thread Safety in the C++ Standard Library](../standard-library/thread-safety-in-the-cpp-standard-library.md)\

docs/standard-library/cache-chunklist-class.md

Lines changed: 0 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -64,8 +64,6 @@ The number of elements in the array to be allocated.
6464

6565
A pointer to the allocated object.
6666

67-
### Remarks
68-
6967
## <a name="cache_chunklist"></a> cache_chunklist::cache_chunklist
7068

7169
Constructs an object of type `cache_chunklist`.
@@ -74,8 +72,6 @@ Constructs an object of type `cache_chunklist`.
7472
cache_chunklist();
7573
```
7674

77-
### Remarks
78-
7975
## <a name="deallocate"></a> cache_chunklist::deallocate
8076

8177
Frees a specified number of objects from storage beginning at a specified position.
@@ -92,8 +88,6 @@ A pointer to the first object to be deallocated from storage.
9288
*count*\
9389
The number of objects to be deallocated from storage.
9490
95-
### Remarks
96-
9791
## See also
9892
9993
[\<allocators>](../standard-library/allocators-header.md)

docs/standard-library/cache-freelist-class.md

Lines changed: 0 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -67,8 +67,6 @@ The number of elements in the array to be allocated.
6767

6868
A pointer to the allocated object.
6969

70-
### Remarks
71-
7270
## <a name="cache_freelist"></a> cache_freelist::cache_freelist
7371

7472
Constructs an object of type `cache_freelist`.
@@ -77,8 +75,6 @@ Constructs an object of type `cache_freelist`.
7775
cache_freelist();
7876
```
7977

80-
### Remarks
81-
8278
## <a name="deallocate"></a> cache_freelist::deallocate
8379

8480
Frees a specified number of objects from storage beginning at a specified position.
@@ -95,8 +91,6 @@ A pointer to the first object to be deallocated from storage.
9591
*count*\
9692
The number of objects to be deallocated from storage.
9793
98-
### Remarks
99-
10094
## See also
10195
10296
[\<allocators>](../standard-library/allocators-header.md)

docs/standard-library/cache-suballoc-class.md

Lines changed: 0 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -64,8 +64,6 @@ The number of elements in the array to be allocated.
6464

6565
A pointer to the allocated object.
6666

67-
### Remarks
68-
6967
## <a name="cache_suballoc"></a> cache_suballoc::cache_suballoc
7068

7169
Constructs an object of type `cache_suballoc`.
@@ -74,8 +72,6 @@ Constructs an object of type `cache_suballoc`.
7472
cache_suballoc();
7573
```
7674

77-
### Remarks
78-
7975
## <a name="deallocate"></a> cache_suballoc::deallocate
8076

8177
Frees a specified number of objects from storage beginning at a specified position.
@@ -92,8 +88,6 @@ A pointer to the first object to be deallocated from storage.
9288
*count*\
9389
The number of objects to be deallocated from storage.
9490
95-
### Remarks
96-
9791
## See also
9892
9993
[\<allocators>](../standard-library/allocators-header.md)

docs/standard-library/error-category-class.md

Lines changed: 0 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -71,8 +71,6 @@ The error code value to store in the [error_condition](../standard-library/error
7171

7272
Returns `error_condition(_Errval, *this)`.
7373

74-
### Remarks
75-
7674
### <a name="equivalent"></a> equivalent
7775

7876
Returns a value that specifies whether error objects are equivalent.
@@ -129,8 +127,6 @@ The error code value to describe.
129127
130128
Returns a descriptive name of the error code *val* for the category. If the error code is unrecognized, returns `"unknown error"`.
131129
132-
#### Remarks
133-
134130
### <a name="name"></a> name
135131
136132
Returns the name of the category.

docs/standard-library/error-code-class.md

Lines changed: 0 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -82,8 +82,6 @@ Returns the error category.
8282
const error_category& category() const;
8383
```
8484

85-
#### Remarks
86-
8785
### <a name="clear"></a> clear
8886

8987
Clears the error code value and category.

docs/standard-library/error-condition-class.md

Lines changed: 0 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -84,8 +84,6 @@ const error_category& category() const;
8484

8585
A reference to the stored error category
8686

87-
#### Remarks
88-
8987
### <a name="clear"></a> clear
9088

9189
Clears the error code value and category.
@@ -264,8 +262,6 @@ value_type value() const;
264262

265263
The stored error code value of type [value_type](#value_type).
266264

267-
#### Remarks
268-
269265
### <a name="value_type"></a> value_type
270266

271267
A type that represents the stored error code value.

docs/standard-library/forward-list-class.md

Lines changed: 0 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -168,8 +168,6 @@ iterator before_begin();
168168

169169
A forward iterator that points just before the first element of the sequence (or just before the end of an empty sequence).
170170

171-
### Remarks
172-
173171
## <a name="begin"></a> `begin`
174172

175173
Returns an iterator addressing the first element in a forward list.
@@ -183,8 +181,6 @@ iterator begin();
183181

184182
A forward iterator that points at the first element of the sequence (or just beyond the end of an empty sequence).
185183

186-
### Remarks
187-
188184
## <a name="cbefore_begin"></a> `cbefore_begin`
189185

190186
Returns a const iterator addressing the position before the first element in a forward list.
@@ -197,8 +193,6 @@ const_iterator cbefore_begin() const;
197193

198194
A forward iterator that points just before the first element of the sequence (or just before the end of an empty sequence).
199195

200-
### Remarks
201-
202196
## <a name="cbegin"></a> `cbegin`
203197

204198
Returns a **`const`** iterator that addresses the first element in the range.
@@ -285,8 +279,6 @@ typedef typename Allocator::const_pointer
285279
const_pointer;
286280
```
287281

288-
### Remarks
289-
290282
## <a name="const_reference"></a> `const_reference`
291283

292284
A type that provides a constant reference to an element in the forward list.
@@ -295,8 +287,6 @@ A type that provides a constant reference to an element in the forward list.
295287
typedef typename Allocator::const_reference const_reference;
296288
```
297289

298-
### Remarks
299-
300290
## <a name="difference_type"></a> `difference_type`
301291

302292
A signed integer type that can be used to represent the number of elements of a forward list in a range between elements pointed to by iterators.
@@ -577,8 +567,6 @@ size_type max_size() const;
577567

578568
The length of the longest sequence that the object can control.
579569

580-
### Remarks
581-
582570
## <a name="merge"></a> `merge`
583571

584572
Combines two sorted sequences into a single sorted sequence in linear time. Removes the elements from the argument list, and inserts them into this `forward_list`. The two lists should be sorted by the same compare function object before the call to `merge`. The combined list will be sorted by that compare function object.

0 commit comments

Comments
 (0)