From d235daa7a292c2c30f33e6c236b561fa5d37d107 Mon Sep 17 00:00:00 2001 From: Rageking8 <106309953+Rageking8@users.noreply.github.com> Date: Sat, 14 Jun 2025 18:29:05 +0800 Subject: [PATCH 1/7] Elide more manual table of contents --- docs/standard-library/allocators-operators.md | 3 --- docs/standard-library/array-functions.md | 3 --- docs/standard-library/array-operators.md | 7 ------- docs/standard-library/ostream-functions.md | 5 ----- docs/standard-library/string-view-operators.md | 9 --------- 5 files changed, 27 deletions(-) diff --git a/docs/standard-library/allocators-operators.md b/docs/standard-library/allocators-operators.md index 90936ade68..56eb3ff993 100644 --- a/docs/standard-library/allocators-operators.md +++ b/docs/standard-library/allocators-operators.md @@ -9,9 +9,6 @@ ms.assetid: b55d67cb-3c69-46bf-ad40-e845fb096c4e These are the global template operator functions defined in ``. For class member operator functions, see the class documentation. -[operator!=](#op_neq)\ -[operator==](#op_eq_eq) - ## operator!= Tests for inequality between allocator objects of a specified class. diff --git a/docs/standard-library/array-functions.md b/docs/standard-library/array-functions.md index a670f42c5b..f035580521 100644 --- a/docs/standard-library/array-functions.md +++ b/docs/standard-library/array-functions.md @@ -10,9 +10,6 @@ helpviewer_keywords: ["std::array [C++], get", "std::get [C++]", "std::swap [C++ The \ header includes two non-member functions, `get` and `swap`, that operate on **array** objects. -[get](#get)\ -[swap](#swap) - ## get Returns a reference to the specified element of the array. diff --git a/docs/standard-library/array-operators.md b/docs/standard-library/array-operators.md index 56925a09ca..dc176efb03 100644 --- a/docs/standard-library/array-operators.md +++ b/docs/standard-library/array-operators.md @@ -8,13 +8,6 @@ f1_keywords: ["array/std::array::operator!=", "array/std::array::operator<", "ar The \ header includes these **array** non-member comparison template functions. -[operator!=](#op_neq)\ -[`operator>`](#op_gt)\ -[`operator>=`](#op_gt_eq)\ -[`operator<`](#op_lt)\ -[`operator<=`](#op_lt_eq)\ -[operator==](#op_eq_eq) - ## operator!= Array comparison, not equal. diff --git a/docs/standard-library/ostream-functions.md b/docs/standard-library/ostream-functions.md index ce0710b50c..df0151d049 100644 --- a/docs/standard-library/ostream-functions.md +++ b/docs/standard-library/ostream-functions.md @@ -10,11 +10,6 @@ helpviewer_keywords: ["std::swap [C++]", "std::endl [C++]", "std::ends [C++]", " These are the global template functions defined in ``. For member functions, see the [basic_ostream Class](basic-ostream-class.md) documentation. -[endl](#endl)\ -[ends](#ends)\ -[flush](#flush)\ -[swap](#swap) - ## endl Terminates a line and flushes the buffer. diff --git a/docs/standard-library/string-view-operators.md b/docs/standard-library/string-view-operators.md index cc6f5a702b..cbcb11b52b 100644 --- a/docs/standard-library/string-view-operators.md +++ b/docs/standard-library/string-view-operators.md @@ -9,15 +9,6 @@ helpviewer_keywords: ["std::basic_string_view::operator!=", "std::basic_string_v Use these operators to compare two `string_view` objects, or a `string_view` and some other string object (for example [`std::string`](basic-string-class.md), or `char*`) for which an implicit conversion is provided. -[`operator!=`](#op_neq)\ -[`operator>`](#op_gt)\ -[`operator>=`](#op_gt_eq)\ -[`operator<`](#op_lt)\ -[`operator<<`](#op_lt_lt)\ -[`operator<=`](#op_lt_eq)\ -[`operator==`](#op_eq_eq)\ -[`operator""sv`](#op_sv) - ## `operator!=` Tests if the object on the left side of the operator is not equal to the object on the right side. From 333929c06c7e9ed8258f351989bb60a97b416c4b Mon Sep 17 00:00:00 2001 From: Rageking8 <106309953+Rageking8@users.noreply.github.com> Date: Sat, 14 Jun 2025 18:36:23 +0800 Subject: [PATCH 2/7] Update metadata for some standard library topics --- docs/standard-library/allocators-operators.md | 5 ++--- docs/standard-library/array-functions.md | 5 ++--- docs/standard-library/ostream-functions.md | 5 ++--- docs/standard-library/string-view-operators.md | 2 +- 4 files changed, 7 insertions(+), 10 deletions(-) diff --git a/docs/standard-library/allocators-operators.md b/docs/standard-library/allocators-operators.md index 56eb3ff993..f8e4ba63b3 100644 --- a/docs/standard-library/allocators-operators.md +++ b/docs/standard-library/allocators-operators.md @@ -1,9 +1,8 @@ --- -description: "Learn more about: operators" title: " operators" -ms.date: "11/04/2016" +description: "Learn more about: operators" +ms.date: 11/04/2016 f1_keywords: ["allocators/std::operator!=", "allocators/std::operator=="] -ms.assetid: b55d67cb-3c69-46bf-ad40-e845fb096c4e --- # `` operators diff --git a/docs/standard-library/array-functions.md b/docs/standard-library/array-functions.md index f035580521..049827d21f 100644 --- a/docs/standard-library/array-functions.md +++ b/docs/standard-library/array-functions.md @@ -1,9 +1,8 @@ --- -description: "Learn more about: functions" title: " functions" -ms.date: "11/04/2016" +description: "Learn more about: functions" +ms.date: 11/04/2016 f1_keywords: ["array/std::array::get", "array/std::get", "array/std::swap"] -ms.assetid: e0700a33-a833-4655-8735-16e71175efc8 helpviewer_keywords: ["std::array [C++], get", "std::get [C++]", "std::swap [C++]"] --- # `` functions diff --git a/docs/standard-library/ostream-functions.md b/docs/standard-library/ostream-functions.md index df0151d049..2675c8a339 100644 --- a/docs/standard-library/ostream-functions.md +++ b/docs/standard-library/ostream-functions.md @@ -1,9 +1,8 @@ --- -description: "Learn more about: functions" title: " functions" -ms.date: "11/04/2016" +description: "Learn more about: functions" +ms.date: 11/04/2016 f1_keywords: ["ostream/std::swap", "ostream/std::endl", "ostream/std::ends", "ostream/std::flush"] -ms.assetid: d6e56cc0-c8df-4dbe-be10-98e14c35ed3a helpviewer_keywords: ["std::swap [C++]", "std::endl [C++]", "std::ends [C++]", "std::flush [C++]"] --- # `` functions diff --git a/docs/standard-library/string-view-operators.md b/docs/standard-library/string-view-operators.md index cbcb11b52b..b3ca601413 100644 --- a/docs/standard-library/string-view-operators.md +++ b/docs/standard-library/string-view-operators.md @@ -1,7 +1,7 @@ --- title: " operators" description: "API reference for the `string_view` operators, which are used to compare two `string_view` objects, or a `string_view` and some other string object" -ms.date: "01/15/2021" +ms.date: 01/15/2021 f1_keywords: ["xstring/basic_string_view::operator!=", "xstring/basic_string_view::operator>", "xstring/basic_string_view::operator>=", "xstring/basic_string_view::operator<", "xstring/basic_string_view::operator<<", "xstring/basic_string_view::operator<=", "xstring/basic_string_view::operator+", "xstring/basic_string_view::operator==", 'xstring/std::literals::string_view_literals::operator "sv', 'std::literals::string_view_literals::operator sv', 'std::literals::string_view_literals', 'string_view_literals'] helpviewer_keywords: ["std::basic_string_view::operator!=", "std::basic_string_view::operator>", "std::basic_string_view::operator>=", "std::basic_string_view::operator<", "std::basic_string_view::operator<<", "std::basic_string_view::operator<=, std::basic_string_view::operator=="] --- From 36ee0db1e37a19f75ed2160d873c99e0e50e4baf Mon Sep 17 00:00:00 2001 From: Rageking8 <106309953+Rageking8@users.noreply.github.com> Date: Sat, 14 Jun 2025 18:38:21 +0800 Subject: [PATCH 3/7] Add backticks in `` operators reference --- docs/standard-library/allocators-operators.md | 14 +++++++------- 1 file changed, 7 insertions(+), 7 deletions(-) diff --git a/docs/standard-library/allocators-operators.md b/docs/standard-library/allocators-operators.md index f8e4ba63b3..8deacf8430 100644 --- a/docs/standard-library/allocators-operators.md +++ b/docs/standard-library/allocators-operators.md @@ -8,7 +8,7 @@ f1_keywords: ["allocators/std::operator!=", "allocators/std::operator=="] These are the global template operator functions defined in ``. For class member operator functions, see the class documentation. -## operator!= +## `operator!=` Tests for inequality between allocator objects of a specified class. @@ -21,10 +21,10 @@ bool operator!=( ### Parameters -*left*\ +*`left`*\ One of the allocator objects to be tested for inequality. -*right*\ +*`right`*\ One of the allocator objects to be tested for inequality. ### Return Value @@ -35,7 +35,7 @@ One of the allocator objects to be tested for inequality. The template operator returns `!(left == right)`. -## operator== +## `operator==` Tests for equality between allocator objects of a specified class. @@ -48,10 +48,10 @@ bool operator==( ### Parameters -*left*\ +*`left`*\ One of the allocator objects to be tested for equality. -*right*\ +*`right`*\ One of the allocator objects to be tested for equality. ### Return Value @@ -64,4 +64,4 @@ This template operator returns `left.equals(right)`. ## See also -[\](allocators-header.md) +[``](allocators-header.md) From db47863625b19a474c0f77a043a957a39a160e91 Mon Sep 17 00:00:00 2001 From: Rageking8 <106309953+Rageking8@users.noreply.github.com> Date: Sat, 14 Jun 2025 18:40:20 +0800 Subject: [PATCH 4/7] Add backticks in `` functions reference --- docs/standard-library/array-functions.md | 24 ++++++++++++------------ 1 file changed, 12 insertions(+), 12 deletions(-) diff --git a/docs/standard-library/array-functions.md b/docs/standard-library/array-functions.md index 049827d21f..60e9c8027c 100644 --- a/docs/standard-library/array-functions.md +++ b/docs/standard-library/array-functions.md @@ -7,9 +7,9 @@ helpviewer_keywords: ["std::array [C++], get", "std::get [C++]", "std::swap [C++ --- # `` functions -The \ header includes two non-member functions, `get` and `swap`, that operate on **array** objects. +The `` header includes two non-member functions, `get` and `swap`, that operate on **array** objects. -## get +## `get` Returns a reference to the specified element of the array. @@ -26,16 +26,16 @@ constexpr T&& get(array&& arr) noexcept; ### Parameters -*Index*\ +*`Index`*\ The element offset. -*T*\ +*`T`*\ The type of an element. -*N*\ +*`N`*\ The number of elements in the array. -*arr*\ +*`arr`*\ The array to select from. ### Example @@ -70,7 +70,7 @@ int main() 1 3 ``` -## swap +## `swap` A non-member template specialization of `std::swap` that swaps two **array** objects. @@ -81,16 +81,16 @@ void swap(array& left, array& right); ### Parameters -*Ty*\ +*`Ty`*\ The type of an element. -*N*\ +*`N`*\ The size of the array. -*left*\ +*`left`*\ The first array to swap. -*right*\ +*`right`*\ The second array to swap. ### Remarks @@ -145,4 +145,4 @@ int main() ## See also -[\](../standard-library/array.md) +[``](../standard-library/array.md) From c8355baa78133b424239edc895d6cbd661fa57f3 Mon Sep 17 00:00:00 2001 From: Rageking8 <106309953+Rageking8@users.noreply.github.com> Date: Sat, 14 Jun 2025 18:43:50 +0800 Subject: [PATCH 5/7] Add backticks in `` operators reference --- docs/standard-library/array-operators.md | 56 ++++++++++++------------ 1 file changed, 28 insertions(+), 28 deletions(-) diff --git a/docs/standard-library/array-operators.md b/docs/standard-library/array-operators.md index dc176efb03..1e076cf550 100644 --- a/docs/standard-library/array-operators.md +++ b/docs/standard-library/array-operators.md @@ -6,9 +6,9 @@ f1_keywords: ["array/std::array::operator!=", "array/std::array::operator<", "ar --- # `` operators -The \ header includes these **array** non-member comparison template functions. +The `` header includes these **array** non-member comparison template functions. -## operator!= +## `operator!=` Array comparison, not equal. @@ -21,16 +21,16 @@ bool operator!=( ### Parameters -*Ty*\ +*`Ty`*\ The type of an element. -*N*\ +*`N`*\ The size of the array. -*left*\ +*`left`*\ Left container to compare. -*right*\ +*`right`*\ Right container to compare. ### Remarks @@ -94,16 +94,16 @@ bool operator<( ### Parameters -*Ty*\ +*`Ty`*\ The type of an element. -*N*\ +*`N`*\ The size of the array. -*left*\ +*`left`*\ Left container to compare. -*right*\ +*`right`*\ Right container to compare. ### Remarks @@ -167,16 +167,16 @@ bool operator<=( ### Parameters -*Ty*\ +*`Ty`*\ The type of an element. -*N*\ +*`N`*\ The size of the array. -*left*\ +*`left`*\ Left container to compare. -*right*\ +*`right`*\ Right container to compare. ### Remarks @@ -227,7 +227,7 @@ true false ``` -## operator== +## `operator==` Array comparison, equal. @@ -240,16 +240,16 @@ bool operator==( ### Parameters -*Ty*\ +*`Ty`*\ The type of an element. -*N*\ +*`N`*\ The size of the array. -*left*\ +*`left`*\ Left container to compare. -*right*\ +*`right`*\ Right container to compare. ### Remarks @@ -313,16 +313,16 @@ bool operator>( ### Parameters -*Ty*\ +*`Ty`*\ The type of an element. -*N*\ +*`N`*\ The size of the array. -*left*\ +*`left`*\ Left container to compare. -*right*\ +*`right`*\ Right container to compare. ### Remarks @@ -386,16 +386,16 @@ bool operator>=( ### Parameters -*Ty*\ +*`Ty`*\ The type of an element. -*N*\ +*`N`*\ The size of the array. -*left*\ +*`left`*\ Left container to compare. -*right*\ +*`right`*\ Right container to compare. ### Remarks @@ -448,4 +448,4 @@ false ## See also -[\](../standard-library/array.md) +[``](../standard-library/array.md) From 9d63f571672fc377200fe86d365f79bcf0d65384 Mon Sep 17 00:00:00 2001 From: Rageking8 <106309953+Rageking8@users.noreply.github.com> Date: Sat, 14 Jun 2025 18:47:56 +0800 Subject: [PATCH 6/7] Add backticks in `` functions reference --- docs/standard-library/ostream-functions.md | 48 +++++++++++----------- 1 file changed, 24 insertions(+), 24 deletions(-) diff --git a/docs/standard-library/ostream-functions.md b/docs/standard-library/ostream-functions.md index 2675c8a339..e306c7f49e 100644 --- a/docs/standard-library/ostream-functions.md +++ b/docs/standard-library/ostream-functions.md @@ -7,9 +7,9 @@ helpviewer_keywords: ["std::swap [C++]", "std::endl [C++]", "std::ends [C++]", " --- # `` functions -These are the global template functions defined in ``. For member functions, see the [basic_ostream Class](basic-ostream-class.md) documentation. +These are the global template functions defined in ``. For member functions, see the [`basic_ostream` Class](basic-ostream-class.md) documentation. -## endl +## `endl` Terminates a line and flushes the buffer. @@ -21,22 +21,22 @@ basic_ostream& endl( ### Parameters -*Elem*\ +*`Elem`*\ The element type. -*Ostr*\ -An object of type **basic_ostream**. +*`Ostr`*\ +An object of type **`basic_ostream`**. -*Tr*\ +*`Tr`*\ Character traits. ### Return Value -An object of type **basic_ostream**. +An object of type **`basic_ostream`**. ### Remarks -The manipulator calls *Ostr*.[put](../standard-library/basic-ostream-class.md#put)(*Ostr*.[widen](../standard-library/basic-ios-class.md#widen)('\n')), and then calls *Ostr*.[flush](../standard-library/basic-ostream-class.md#flush). It returns *Ostr*. +The manipulator calls *`Ostr`*.[`put`](../standard-library/basic-ostream-class.md#put)(*`Ostr`*.[`widen`](../standard-library/basic-ios-class.md#widen)('\n')), and then calls *`Ostr`*.[`flush`](../standard-library/basic-ostream-class.md#flush). It returns *`Ostr`*. ### Example @@ -56,7 +56,7 @@ int main( ) testing ``` -## ends +## `ends` Terminates a string. @@ -68,13 +68,13 @@ basic_ostream& ends( ### Parameters -*Elem*\ +*`Elem`*\ The element type. -*Ostr*\ +*`Ostr`*\ An object of type `basic_ostream`. -*Tr*\ +*`Tr`*\ Character traits. ### Return Value @@ -83,7 +83,7 @@ An object of type `basic_ostream`. ### Remarks -The manipulator calls *Ostr*.[put](../standard-library/basic-ostream-class.md#put)(*Elem*('\0')). It returns *Ostr*. +The manipulator calls *`Ostr`*.[`put`](../standard-library/basic-ostream-class.md#put)(*`Elem`*('\0')). It returns *`Ostr`*. ### Example @@ -105,7 +105,7 @@ int main( ) ab c ``` -## flush +## `flush` Flushes the buffer. @@ -117,13 +117,13 @@ basic_ostream& flush( ### Parameters -*Elem*\ +*`Elem`*\ The element type. -*Ostr*\ +*`Ostr`*\ An object of type `basic_ostream`. -*Tr*\ +*`Tr`*\ Character traits. ### Return Value @@ -132,7 +132,7 @@ An object of type `basic_ostream`. ### Remarks -The manipulator calls *Ostr*.[flush](../standard-library/basic-ostream-class.md#flush). It returns *Ostr*. +The manipulator calls *`Ostr`*.[`flush`](../standard-library/basic-ostream-class.md#flush). It returns *`Ostr`*. ### Example @@ -152,7 +152,7 @@ int main( ) testing ``` -## swap +## `swap` Exchanges the values of two `basic_ostream` objects. @@ -165,16 +165,16 @@ void swap( ### Parameters -*Elem*\ +*`Elem`*\ The element type. -*Tr*\ +*`Tr`*\ Character traits. -*left*\ +*`left`*\ An lvalue reference to a `basic_ostream` object. -*right*\ +*`right`*\ An lvalue reference to a `basic_ostream` object. ### Remarks @@ -183,4 +183,4 @@ The template function `swap` executes `left.swap(right)`. ## See also -[\](../standard-library/ostream.md) +[``](../standard-library/ostream.md) From 30839fff0089c8e67a2c324ea97f6e509fdb5ed0 Mon Sep 17 00:00:00 2001 From: Rageking8 <106309953+Rageking8@users.noreply.github.com> Date: Sat, 14 Jun 2025 18:51:17 +0800 Subject: [PATCH 7/7] Add backticks in `` operators reference --- .../standard-library/string-view-operators.md | 24 +++++++++---------- 1 file changed, 12 insertions(+), 12 deletions(-) diff --git a/docs/standard-library/string-view-operators.md b/docs/standard-library/string-view-operators.md index b3ca601413..a79ca556d7 100644 --- a/docs/standard-library/string-view-operators.md +++ b/docs/standard-library/string-view-operators.md @@ -32,10 +32,10 @@ bool operator!=( ### Parameters -*left*\ +*`left`*\ Any convertible string type or an object of type `basic_string_view` to be compared. -*right*\ +*`right`*\ Any convertible string type or an object of type `basic_string_view` to be compared. ### Return Value @@ -71,10 +71,10 @@ bool operator==( ### Parameters -*left*\ +*`left`*\ Any convertible string type or an object of type `basic_string_view` to be compared. -*right*\ +*`right`*\ Any convertible string type or an object of type `basic_string_view` to be compared. ### Return Value @@ -110,10 +110,10 @@ bool operator<( ### Parameters -*left*\ +*`left`*\ Any convertible string type or an object of type `basic_string_view` to be compared. -*right*\ +*`right`*\ Any convertible string type or an object of type `basic_string_view` to be compared. ### Return Value @@ -122,7 +122,7 @@ Any convertible string type or an object of type `basic_string_view` to be compa ### Remarks -An implicit conversion must exist from *convertible_string_type* to the string_view on the other side. +An implicit conversion must exist from *convertible_string_type* to the `string_view` on the other side. The comparison is based on a pairwise lexicographical comparison of the character sequences. When the first unequal pair of characters is encountered, the result of that comparison is returned. If no unequal characters are found, but one sequence is shorter, the shorter sequence is less than the longer one. In other words, "cat" is less than "cats". @@ -171,10 +171,10 @@ bool operator<=( ### Parameters -*left*\ +*`left`*\ Any convertible string type or an object of type `basic_string_view` to be compared. -*right*\ +*`right`*\ Any convertible string type or an object of type `basic_string_view` to be compared. ### Return Value @@ -201,7 +201,7 @@ inline basic_ostream& operator<<( an output stream being written to. *`Str`*\ -The string_view to be entered into an output stream. +The `string_view` to be entered into an output stream. ### Return Value @@ -234,10 +234,10 @@ bool operator>( ### Parameters -*left*\ +*`left`*\ Any convertible string type or an object of type `basic_string_view` to be compared. -*right*\ +*`right`*\ Any convertible string type or an object of type `basic_string_view` to be compared. ### Return Value