From b57ac0472820148679c0e3f7a42d43fbea152f21 Mon Sep 17 00:00:00 2001 From: Christian Mazakas Date: Wed, 23 Feb 2022 14:36:04 -0800 Subject: [PATCH] Update reference docs to include `[[nodiscard]]` annotations --- doc/unordered/unordered_map.adoc | 4 ++-- doc/unordered/unordered_multimap.adoc | 4 ++-- doc/unordered/unordered_multiset.adoc | 4 ++-- doc/unordered/unordered_set.adoc | 4 ++-- 4 files changed, 8 insertions(+), 8 deletions(-) diff --git a/doc/unordered/unordered_map.adoc b/doc/unordered/unordered_map.adoc index e8737402..f4f9f9ec 100644 --- a/doc/unordered/unordered_map.adoc +++ b/doc/unordered/unordered_map.adoc @@ -87,7 +87,7 @@ namespace boost { const_iterator xref:#unordered_map_cend[cend]() const noexcept; // capacity - bool xref:#unordered_map_empty[empty]() const noexcept; + ++[[nodiscard]]++ bool xref:#unordered_map_empty[empty]() const noexcept; size_type xref:#unordered_map_size[size]() const noexcept; size_type xref:#unordered_map_max_size[max_size]() const noexcept; @@ -629,7 +629,7 @@ Returns:;; A `const_iterator` which refers to the past-the-end value for the con ==== empty ```c++ -bool empty() const noexcept; +[[nodiscard]] bool empty() const noexcept; ``` [horizontal] diff --git a/doc/unordered/unordered_multimap.adoc b/doc/unordered/unordered_multimap.adoc index 8eb8fb30..a621fe4e 100644 --- a/doc/unordered/unordered_multimap.adoc +++ b/doc/unordered/unordered_multimap.adoc @@ -88,7 +88,7 @@ namespace boost { const_iterator xref:#unordered_multimap_cend[cend]() const noexcept; // capacity - bool xref:#unordered_multimap_empty[empty]() const noexcept; + ++[[nodiscard]]++ bool xref:#unordered_multimap_empty[empty]() const noexcept; size_type xref:#unordered_multimap_size[size]() const noexcept; size_type xref:#unordered_multimap_max_size[max_size]() const noexcept; @@ -612,7 +612,7 @@ Returns:;; A `const_iterator` which refers to the past-the-end value for the con ==== empty ```c++ -bool empty() const noexcept; +[[nodiscard]] bool empty() const noexcept; ``` [horizontal] diff --git a/doc/unordered/unordered_multiset.adoc b/doc/unordered/unordered_multiset.adoc index 122a1b27..f806f9ee 100644 --- a/doc/unordered/unordered_multiset.adoc +++ b/doc/unordered/unordered_multiset.adoc @@ -84,7 +84,7 @@ namespace boost { const_iterator xref:#unordered_multiset_cend[cend]() const noexcept; // capacity - bool xref:#unordered_multiset_empty[empty]() const noexcept; + ++[[nodiscard]]++ bool xref:#unordered_multiset_empty[empty]() const noexcept; size_type xref:#unordered_multiset_size[size]() const noexcept; size_type xref:#unordered_multiset_max_size[max_size]() const noexcept; @@ -607,7 +607,7 @@ Returns:;; A `const_iterator` which refers to the past-the-end value for the con ==== empty ```c++ -bool empty() const noexcept; +[[nodiscard]] bool empty() const noexcept; ``` [horizontal] diff --git a/doc/unordered/unordered_set.adoc b/doc/unordered/unordered_set.adoc index e976b97a..426ddd9a 100644 --- a/doc/unordered/unordered_set.adoc +++ b/doc/unordered/unordered_set.adoc @@ -85,7 +85,7 @@ namespace boost { const_iterator xref:#unordered_set_cend[cend]() const noexcept; // capacity - bool xref:#unordered_set_empty[empty]() const noexcept; + ++[[nodiscard]]++ bool xref:#unordered_set_empty[empty]() const noexcept; size_type xref:#unordered_set_size[size]() const noexcept; size_type xref:#unordered_set_max_size[max_size]() const noexcept; @@ -618,7 +618,7 @@ Returns:;; A `const_iterator` which refers to the past-the-end value for the con ==== empty ```c++ -bool empty() const noexcept; +[[nodiscard]] bool empty() const noexcept; ``` [horizontal]