Skip to content

Commit b94d2d1

Browse files
author
Colin Robertson
committed
Add F1 for literals in std library
1 parent c2ab2a2 commit b94d2d1

4 files changed

Lines changed: 17 additions & 4 deletions

File tree

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

Lines changed: 14 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,8 @@
11
---
22
title: "basic_string Class"
33
description: "API reference for the Standard C++ string class, `basic_string`."
4-
ms.date: "10/26/2020"
5-
f1_keywords: ["xstring/std::basic_string", "xstring/std::basic_string::allocator_type", "xstring/std::basic_string::const_iterator", "xstring/std::basic_string::const_pointer", "xstring/std::basic_string::const_reference", "xstring/std::basic_string::const_reverse_iterator", "xstring/std::basic_string::difference_type", "xstring/std::basic_string::iterator", "xstring/std::basic_string::npos", "xstring/std::basic_string::pointer", "xstring/std::basic_string::reference", "xstring/std::basic_string::reverse_iterator", "xstring/std::basic_string::size_type", "xstring/std::basic_string::traits_type", "xstring/std::basic_string::value_type", "xstring/std::basic_string::append", "xstring/std::basic_string::assign", "xstring/std::basic_string::at", "xstring/std::basic_string::back", "xstring/std::basic_string::begin", "xstring/std::basic_string::c_str", "xstring/std::basic_string::capacity", "xstring/std::basic_string::cbegin", "xstring/std::basic_string::cend", "xstring/std::basic_string::clear", "xstring/std::basic_string::compare", "xstring/std::basic_string::copy", "xstring/std::basic_string::crbegin", "xstring/std::basic_string::crend", "xstring/std::basic_string::_Copy_s", "xstring/std::basic_string::data", "xstring/std::basic_string::empty", "xstring/std::basic_string::end", "xstring/std::basic_string::erase", "xstring/std::basic_string::find", "xstring/std::basic_string::find_first_not_of", "xstring/std::basic_string::find_first_of", "xstring/std::basic_string::find_last_not_of", "xstring/std::basic_string::find_last_of", "xstring/std::basic_string::front", "xstring/std::basic_string::get_allocator", "xstring/std::basic_string::insert", "xstring/std::basic_string::length", "xstring/std::basic_string::max_size", "xstring/std::basic_string::pop_back", "xstring/std::basic_string::push_back", "xstring/std::basic_string::rbegin", "xstring/std::basic_string::rend", "xstring/std::basic_string::replace", "xstring/std::basic_string::reserve", "xstring/std::basic_string::resize", "xstring/std::basic_string::rfind", "xstring/std::basic_string::shrink_to_fit", "xstring/std::basic_string::size", "xstring/std::basic_string::substr", "xstring/std::basic_string::ends_with", "xstring/std::basic_string::starts_with", "xstring/std::basic_string::swap"]
4+
ms.date: "01/15/2021"
5+
f1_keywords: ["xstring/std::basic_string", "xstring/std::basic_string::allocator_type", "xstring/std::basic_string::const_iterator", "xstring/std::basic_string::const_pointer", "xstring/std::basic_string::const_reference", "xstring/std::basic_string::const_reverse_iterator", "xstring/std::basic_string::difference_type", "xstring/std::basic_string::iterator", "xstring/std::basic_string::npos", "xstring/std::basic_string::pointer", "xstring/std::basic_string::reference", "xstring/std::basic_string::reverse_iterator", "xstring/std::basic_string::size_type", "xstring/std::basic_string::traits_type", "xstring/std::basic_string::value_type", "xstring/std::basic_string::append", "xstring/std::basic_string::assign", "xstring/std::basic_string::at", "xstring/std::basic_string::back", "xstring/std::basic_string::begin", "xstring/std::basic_string::c_str", "xstring/std::basic_string::capacity", "xstring/std::basic_string::cbegin", "xstring/std::basic_string::cend", "xstring/std::basic_string::clear", "xstring/std::basic_string::compare", "xstring/std::basic_string::copy", "xstring/std::basic_string::crbegin", "xstring/std::basic_string::crend", "xstring/std::basic_string::_Copy_s", "xstring/std::basic_string::data", "xstring/std::basic_string::empty", "xstring/std::basic_string::end", "xstring/std::basic_string::erase", "xstring/std::basic_string::find", "xstring/std::basic_string::find_first_not_of", "xstring/std::basic_string::find_first_of", "xstring/std::basic_string::find_last_not_of", "xstring/std::basic_string::find_last_of", "xstring/std::basic_string::front", "xstring/std::basic_string::get_allocator", "xstring/std::basic_string::insert", "xstring/std::basic_string::length", "xstring/std::basic_string::max_size", "xstring/std::basic_string::pop_back", "xstring/std::basic_string::push_back", "xstring/std::basic_string::rbegin", "xstring/std::basic_string::rend", "xstring/std::basic_string::replace", "xstring/std::basic_string::reserve", "xstring/std::basic_string::resize", "xstring/std::basic_string::rfind", "xstring/std::basic_string::shrink_to_fit", "xstring/std::basic_string::size", "xstring/std::basic_string::substr", "xstring/std::basic_string::ends_with", "xstring/std::basic_string::starts_with", "xstring/std::basic_string::swap", 'xstring/std::literals::string_literals', 'std::literals::string_literals', 'string_literals', 'xstring/std::literals::string_literals::operator "s', 'std::literals::string_literals::operator s']
66
helpviewer_keywords: ["std::basic_string [C++]", "std::basic_string [C++], allocator_type", "std::basic_string [C++], const_iterator", "std::basic_string [C++], const_pointer", "std::basic_string [C++], const_reference", "std::basic_string [C++], const_reverse_iterator", "std::basic_string [C++], difference_type", "std::basic_string [C++], iterator", "std::basic_string [C++], npos", "std::basic_string [C++], pointer", "std::basic_string [C++], reference", "std::basic_string [C++], reverse_iterator", "std::basic_string [C++], size_type", "std::basic_string [C++], traits_type", "std::basic_string [C++], value_type", "std::basic_string [C++], append", "std::basic_string [C++], assign", "std::basic_string [C++], at", "std::basic_string [C++], back", "std::basic_string [C++], begin", "std::basic_string [C++], c_str", "std::basic_string [C++], capacity", "std::basic_string [C++], cbegin", "std::basic_string [C++], cend", "std::basic_string [C++], clear", "std::basic_string [C++], compare", "std::basic_string [C++], copy", "std::basic_string [C++], crbegin", "std::basic_string [C++], crend", "std::basic_string [C++], _Copy_s", "std::basic_string [C++], data", "std::basic_string [C++], empty", "std::basic_string [C++], end", "std::basic_string [C++], erase", "std::basic_string [C++], find", "std::basic_string [C++], find_first_not_of", "std::basic_string [C++], find_first_of", "std::basic_string [C++], find_last_not_of", "std::basic_string [C++], find_last_of", "std::basic_string [C++], front", "std::basic_string [C++], get_allocator", "std::basic_string [C++], insert", "std::basic_string [C++], length", "std::basic_string [C++], max_size", "std::basic_string [C++], pop_back", "std::basic_string [C++], push_back", "std::basic_string [C++], rbegin", "std::basic_string [C++], rend", "std::basic_string [C++], replace", "std::basic_string [C++], reserve", "std::basic_string [C++], resize", "std::basic_string [C++], rfind", "std::basic_string [C++], shrink_to_fit", "std::basic_string [C++], size", "std::basic_string [C++], starts_with", "std::basic_string [C++], ends_with","std::basic_string [C++], substr", "std::basic_string [C++], swap"]
77
ms.assetid: a9c3e0a2-39bf-4c8a-b093-9abe30839591
88
---
@@ -109,6 +109,18 @@ The type that represents the stored allocator object that encapsulates details a
109109
|[`operator=`](#op_eq)|Assigns new character values to the contents of a string.|
110110
|[`operator`[]](#op_at)|Provides a reference to the character with a specified index in a string.|
111111
112+
### Literals
113+
114+
The headers that define `basic_string` also define the following [user-defined literals](../cpp/user-defined-literals-cpp.md) which create a string of the specified type from the input parameters.
115+
116+
| Declaration | Description |
117+
|--|--|
118+
| `inline string operator"" s(const char* str, size_t len)` | Returns: `string(str, len)` |
119+
| `inline string operator"" s(const wchar_t* str, size_t len)` | Returns: `wstring(str, len)` |
120+
| `inline basic_string<char8_t> operator"" s(const char8_t* str, size_t len)` | Returns: `basic_string<char8_t>(str, len)` |
121+
| `inline u16string operator"" s(const char16_t* str, size_t len)` | Returns: `u16string(str, len)` |
122+
| `inline u32string operator"" s(const char32_t* str, size_t len)` | Returns: `u32string(str, len)` |
123+
112124
## Remarks
113125
114126
If a function is asked to generate a sequence longer than [`max_size`](#max_size) elements, the function reports a length error by throwing an object of type [`length_error`](../standard-library/length-error-class.md).

docs/standard-library/chrono-literals.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,7 @@
11
---
22
description: "Learn more about: chrono literals"
33
title: "chrono literals"
4+
f1_keywords: ["std::literals::chrono_literals", "chrono_literals"]
45
ms.date: "11/04/2016"
56
ms.assetid: 1a9e23b1-256f-4570-8226-5fa7364fb032
67
---

docs/standard-library/complex.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22
description: "Learn more about: &lt;complex&gt;"
33
title: "&lt;complex&gt;"
44
ms.date: "11/04/2016"
5-
f1_keywords: ["<complex>"]
5+
f1_keywords: ["<complex>", 'std::literals::complex_literals', 'complex_literals', 'complex/std::literals::complex_literals::operator "i', 'std::literals::complex_literals::operator i', 'complex/std::literals::complex_literals::operator "if', 'std::literals::complex_literals::operator if', 'complex/std::literals::complex_literals::operator "i', 'std::literals::complex_literals::operator i']
66
helpviewer_keywords: ["complex header"]
77
ms.assetid: 5e728995-3059-496a-9ce9-61d1bfbe4f2b
88
---

docs/standard-library/string-view-operators.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22
title: "&lt;string_view&gt; operators"
33
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"
44
ms.date: "9/4/2020"
5-
f1_keywords: ["xstring/basic_string_view::operator!=", "xstring/basic_string_view::operator&gt;", "xstring/basic_string_view::operator&gt;=", "xstring/basic_string_view::operator&lt;", "xstring/basic_string_view::operator&lt;&lt;", "xstring/basic_string_view::operator&lt;=", "xstring/basic_string_view::operator+", "xstring/basic_string_view::operator=="]
5+
f1_keywords: ["xstring/basic_string_view::operator!=", "xstring/basic_string_view::operator&gt;", "xstring/basic_string_view::operator&gt;=", "xstring/basic_string_view::operator&lt;", "xstring/basic_string_view::operator&lt;&lt;", "xstring/basic_string_view::operator&lt;=", "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']
66
helpviewer_keywords: ["std::basic_string_view::operator!=", "std::basic_string_view::operator&gt;", "std::basic_string_view::operator&gt;=", "std::basic_string_view::operator&lt;", "std::basic_string_view::operator&lt;&lt;", "std::basic_string_view::operator&lt;=, std::basic_string_view::operator=="]
77
---
88
# &lt;string_view&gt; operators

0 commit comments

Comments
 (0)