Skip to content

Clean up empty "Remarks" headings in standard library #5491

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 2 commits into
base: main
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
11 changes: 2 additions & 9 deletions docs/standard-library/allocators-functions.md
Original file line number Diff line number Diff line change
@@ -1,9 +1,8 @@
---
description: "Learn more about: <allocators> macros"
title: "<allocators> macros"
ms.date: "11/04/2016"
description: "Learn more about: <allocators> macros"
ms.date: 11/04/2016
f1_keywords: ["allocators/std::ALLOCATOR_DECL", "allocators/std::CACHE_CHUNKLIST", "allocators/std::CACHE_FREELIST", "allocators/std::CACHE_SUBALLOC", "allocators/std::SYNC_DEFAULT"]
ms.assetid: 9cb5ee07-1ff9-4594-ae32-3c8c6efb511a
helpviewer_keywords: ["std::ALLOCATOR_DECL [C++]", "std::CACHE_CHUNKLIST [C++]", "std::CACHE_FREELIST [C++]", "std::CACHE_SUBALLOC [C++]", "std::SYNC_DEFAULT [C++]"]
---
# `<allocators>` macros
Expand Down Expand Up @@ -72,8 +71,6 @@ Yields `stdext::allocators::cache_chunklist<sizeof(Type)>`.
#define CACHE_CHUNKLIST <cache_class>
```

### Remarks

## <a name="cache_freelist"></a> CACHE_FREELIST

Yields `stdext::allocators::cache_freelist<sizeof(Type), max>`.
Expand All @@ -82,8 +79,6 @@ Yields `stdext::allocators::cache_freelist<sizeof(Type), max>`.
#define CACHE_FREELIST(max) <cache_class>
```

### Remarks

## <a name="cache_suballoc"></a> CACHE_SUBALLOC

Yields `stdext::allocators::cache_suballoc<sizeof(Type)>`.
Expand All @@ -92,8 +87,6 @@ Yields `stdext::allocators::cache_suballoc<sizeof(Type)>`.
#define CACHE_SUBALLOC <cache_class>
```

### Remarks

## <a name="sync_default"></a> SYNC_DEFAULT

Yields a synchronization filter.
Expand Down
6 changes: 0 additions & 6 deletions docs/standard-library/basic-string-class.md
Original file line number Diff line number Diff line change
Expand Up @@ -569,8 +569,6 @@ reference back();

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

### Remarks

## <a name="basic_string"></a> `basic_string::basic_string`

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.
Expand Down Expand Up @@ -1473,8 +1471,6 @@ const_reverse_iterator crend() const;

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).

### Remarks

## <a name="copy_s"></a> `basic_string::_Copy_s`

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

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

### Remarks

## <a name="get_allocator"></a> `basic_string::get_allocator`

Returns a copy of the allocator object used to construct the string.
Expand Down
7 changes: 1 addition & 6 deletions docs/standard-library/basic-stringbuf-class.md
Original file line number Diff line number Diff line change
@@ -1,10 +1,9 @@
---
description: "Learn more about: basic_stringbuf Class"
title: "basic_stringbuf Class"
description: "Learn more about: basic_stringbuf Class"
ms.date: 06/10/2022
f1_keywords: ["sstream/std::basic_stringbuf", "sstream/std::basic_stringbuf::allocator_type", "sstream/std::basic_stringbuf::char_type", "sstream/std::basic_stringbuf::int_type", "sstream/std::basic_stringbuf::off_type", "sstream/std::basic_stringbuf::pos_type", "sstream/std::basic_stringbuf::traits_type", "sstream/std::basic_stringbuf::overflow", "sstream/std::basic_stringbuf::pbackfail", "sstream/std::basic_stringbuf::seekoff", "sstream/std::basic_stringbuf::seekpos", "sstream/std::basic_stringbuf::str", "sstream/std::basic_stringbuf::underflow"]
helpviewer_keywords: ["std::basic_stringbuf [C++]", "std::basic_stringbuf [C++], allocator_type", "std::basic_stringbuf [C++], char_type", "std::basic_stringbuf [C++], int_type", "std::basic_stringbuf [C++], off_type", "std::basic_stringbuf [C++], pos_type", "std::basic_stringbuf [C++], traits_type", "std::basic_stringbuf [C++], overflow", "std::basic_stringbuf [C++], pbackfail", "std::basic_stringbuf [C++], seekoff", "std::basic_stringbuf [C++], seekpos", "std::basic_stringbuf [C++], str", "std::basic_stringbuf [C++], underflow"]
ms.assetid: 40c85f9e-42a5-4a65-af5c-23c8e3bf8113
ms.custom: devdivchpfy22
---

Expand Down Expand Up @@ -365,8 +364,6 @@ void basic_stringbuf<T>::swap(basic_stringbuf& other)
*other*\
The basic_stringbuf whose contents will be swapped with this basic_stringbuf.

### Remarks

## <a name="op_eq"></a> basic_stringbuf::operator=

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

### Remarks

## See also

[Thread Safety in the C++ Standard Library](../standard-library/thread-safety-in-the-cpp-standard-library.md)\
Expand Down
11 changes: 2 additions & 9 deletions docs/standard-library/cache-chunklist-class.md
Original file line number Diff line number Diff line change
@@ -1,10 +1,9 @@
---
description: "Learn more about: cache_chunklist Class"
title: "cache_chunklist Class"
ms.date: "11/04/2016"
description: "Learn more about: cache_chunklist Class"
ms.date: 11/04/2016
f1_keywords: ["allocators/stdext::cache_chunklist", "allocators/stdext::cache_chunklist::allocate", "allocators/stdext::cache_chunklist::deallocate"]
helpviewer_keywords: ["stdext::cache_chunklist", "stdext::cache_chunklist [C++], allocate", "stdext::cache_chunklist [C++], deallocate"]
ms.assetid: af19eccc-4ae7-4a34-bbb2-81e397424cb9
---
# cache_chunklist Class

Expand Down Expand Up @@ -64,8 +63,6 @@ The number of elements in the array to be allocated.

A pointer to the allocated object.

### Remarks

## <a name="cache_chunklist"></a> cache_chunklist::cache_chunklist

Constructs an object of type `cache_chunklist`.
Expand All @@ -74,8 +71,6 @@ Constructs an object of type `cache_chunklist`.
cache_chunklist();
```

### Remarks

## <a name="deallocate"></a> cache_chunklist::deallocate

Frees a specified number of objects from storage beginning at a specified position.
Expand All @@ -92,8 +87,6 @@ A pointer to the first object to be deallocated from storage.
*count*\
The number of objects to be deallocated from storage.

### Remarks

## See also

[\<allocators>](../standard-library/allocators-header.md)
11 changes: 2 additions & 9 deletions docs/standard-library/cache-freelist-class.md
Original file line number Diff line number Diff line change
@@ -1,10 +1,9 @@
---
description: "Learn more about: cache_freelist Class"
title: "cache_freelist Class"
ms.date: "11/04/2016"
description: "Learn more about: cache_freelist Class"
ms.date: 11/04/2016
f1_keywords: ["allocators/stdext::cache_freelist", "allocators/stdext::cache_freelist::allocate", "allocators/stdext::cache_freelist::deallocate"]
helpviewer_keywords: ["stdext::cache_freelist", "stdext::cache_freelist [C++], allocate", "stdext::cache_freelist [C++], deallocate"]
ms.assetid: 840694de-36ba-470f-8dae-2b723d5a8cd9
---
# cache_freelist Class

Expand Down Expand Up @@ -67,8 +66,6 @@ The number of elements in the array to be allocated.

A pointer to the allocated object.

### Remarks

## <a name="cache_freelist"></a> cache_freelist::cache_freelist

Constructs an object of type `cache_freelist`.
Expand All @@ -77,8 +74,6 @@ Constructs an object of type `cache_freelist`.
cache_freelist();
```

### Remarks

## <a name="deallocate"></a> cache_freelist::deallocate

Frees a specified number of objects from storage beginning at a specified position.
Expand All @@ -95,8 +90,6 @@ A pointer to the first object to be deallocated from storage.
*count*\
The number of objects to be deallocated from storage.

### Remarks

## See also

[\<allocators>](../standard-library/allocators-header.md)
11 changes: 2 additions & 9 deletions docs/standard-library/cache-suballoc-class.md
Original file line number Diff line number Diff line change
@@ -1,10 +1,9 @@
---
description: "Learn more about: cache_suballoc Class"
title: "cache_suballoc Class"
ms.date: "11/04/2016"
description: "Learn more about: cache_suballoc Class"
ms.date: 11/04/2016
f1_keywords: ["allocators/stdext::cache_suballoc", "allocators/stdext::cache_suballoc::allocate", "allocators/stdext::cache_suballoc::deallocate"]
helpviewer_keywords: ["stdext::cache_suballoc", "stdext::cache_suballoc [C++], allocate", "stdext::cache_suballoc [C++], deallocate"]
ms.assetid: 9ea9c5e9-1dcc-45d0-b3a7-a56a93d88898
---
# cache_suballoc Class

Expand Down Expand Up @@ -64,8 +63,6 @@ The number of elements in the array to be allocated.

A pointer to the allocated object.

### Remarks

## <a name="cache_suballoc"></a> cache_suballoc::cache_suballoc

Constructs an object of type `cache_suballoc`.
Expand All @@ -74,8 +71,6 @@ Constructs an object of type `cache_suballoc`.
cache_suballoc();
```

### Remarks

## <a name="deallocate"></a> cache_suballoc::deallocate

Frees a specified number of objects from storage beginning at a specified position.
Expand All @@ -92,8 +87,6 @@ A pointer to the first object to be deallocated from storage.
*count*\
The number of objects to be deallocated from storage.

### Remarks

## See also

[\<allocators>](../standard-library/allocators-header.md)
7 changes: 1 addition & 6 deletions docs/standard-library/error-category-class.md
Original file line number Diff line number Diff line change
@@ -1,10 +1,9 @@
---
description: "Learn more about: error_category Class"
title: "error_category Class"
description: "Learn more about: error_category Class"
ms.date: 06/15/2022
f1_keywords: ["system_error/std::error_category", "system_error/std::error_category::value_type", "system_error/std::error_category::default_error_condition", "system_error/std::error_category::equivalent", "system_error/std::error_category::message", "system_error/std::error_category::name"]
helpviewer_keywords: ["std::error_category", "std::error_category::value_type", "std::error_category::default_error_condition", "std::error_category::equivalent", "std::error_category::message", "std::error_category::name"]
ms.assetid: e0a71e14-852d-4905-acd6-5f8ed426706d
ms.custom: devdivchpfy22
---

Expand Down Expand Up @@ -71,8 +70,6 @@ The error code value to store in the [error_condition](../standard-library/error

Returns `error_condition(_Errval, *this)`.

### Remarks

### <a name="equivalent"></a> equivalent

Returns a value that specifies whether error objects are equivalent.
Expand Down Expand Up @@ -129,8 +126,6 @@ The error code value to describe.

Returns a descriptive name of the error code *val* for the category. If the error code is unrecognized, returns `"unknown error"`.

#### Remarks

### <a name="name"></a> name

Returns the name of the category.
Expand Down
7 changes: 2 additions & 5 deletions docs/standard-library/error-code-class.md
Original file line number Diff line number Diff line change
@@ -1,10 +1,9 @@
---
description: "Learn more about: error_code Class"
title: "error_code Class"
ms.date: "11/04/2016"
description: "Learn more about: error_code Class"
ms.date: 11/04/2016
f1_keywords: ["system_error/std::error_code", "system_error/std::error_code::value_type", "system_error/std::error_code::assign", "system_error/std::error_code::category", "system_error/std::error_code::clear", "system_error/std::error_code::default_error_condition", "system_error/std::error_code::message", "system_error/std::error_code::operator bool"]
helpviewer_keywords: ["std::error_code", "std::error_code::value_type", "std::error_code::assign", "std::error_code::category", "std::error_code::clear", "std::error_code::default_error_condition", "std::error_code::message"]
ms.assetid: c09b4a96-cb14-4281-a319-63543f9b2b4a
---
# error_code Class

Expand Down Expand Up @@ -82,8 +81,6 @@ Returns the error category.
const error_category& category() const;
```

#### Remarks

### <a name="clear"></a> clear

Clears the error code value and category.
Expand Down
4 changes: 0 additions & 4 deletions docs/standard-library/error-condition-class.md
Original file line number Diff line number Diff line change
Expand Up @@ -84,8 +84,6 @@ const error_category& category() const;

A reference to the stored error category

#### Remarks

### <a name="clear"></a> clear

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

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

#### Remarks

### <a name="value_type"></a> value_type

A type that represents the stored error code value.
Expand Down
12 changes: 0 additions & 12 deletions docs/standard-library/forward-list-class.md
Original file line number Diff line number Diff line change
Expand Up @@ -168,8 +168,6 @@ iterator before_begin();

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

### Remarks

## <a name="begin"></a> `begin`

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

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

### Remarks

## <a name="cbefore_begin"></a> `cbefore_begin`

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

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

### Remarks

## <a name="cbegin"></a> `cbegin`

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

### Remarks

## <a name="const_reference"></a> `const_reference`

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

### Remarks

## <a name="difference_type"></a> `difference_type`

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.
Expand Down Expand Up @@ -577,8 +567,6 @@ size_type max_size() const;

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

### Remarks

## <a name="merge"></a> `merge`

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.
Expand Down
7 changes: 2 additions & 5 deletions docs/standard-library/freelist-class.md
Original file line number Diff line number Diff line change
@@ -1,10 +1,9 @@
---
description: "Learn more about: freelist Class"
title: "freelist Class"
ms.date: "11/04/2016"
description: "Learn more about: freelist Class"
ms.date: 11/04/2016
f1_keywords: ["allocators/stdext::freelist", "allocators/stdext::freelist::pop", "allocators/stdext::freelist::push"]
helpviewer_keywords: ["stdext::freelist", "stdext::freelist [C++], pop", "stdext::freelist [C++], push"]
ms.assetid: 8ad7e35c-4c80-4479-8ede-1a2497b06d71
---
# freelist Class

Expand Down Expand Up @@ -56,8 +55,6 @@ Constructs an object of type `freelist`.
freelist();
```

### Remarks

## <a name="pop"></a> freelist::pop

Removes the first memory block from the free list.
Expand Down
Loading