From a40e018de202eb5182bcae447054287a8fbef280 Mon Sep 17 00:00:00 2001 From: Joseph Edwards Date: Mon, 16 Dec 2024 18:34:07 +0000 Subject: [PATCH] Change \exception -> \exceptions to make doc output consistent --- include/libsemigroups/aho-corasick.hpp | 2 +- include/libsemigroups/detail/rewriters.hpp | 18 +++++++++--------- include/libsemigroups/transf.hpp | 2 +- include/libsemigroups/word-graph.hpp | 8 ++++---- 4 files changed, 15 insertions(+), 15 deletions(-) diff --git a/include/libsemigroups/aho-corasick.hpp b/include/libsemigroups/aho-corasick.hpp index f4888add4..de592de8f 100644 --- a/include/libsemigroups/aho-corasick.hpp +++ b/include/libsemigroups/aho-corasick.hpp @@ -725,7 +725,7 @@ namespace libsemigroups { //! //! \returns A string containing a representation of \p ac. //! - //! \exception + //! \exceptions //! \no_libsemigroups_except // TODO (now) rename this to_human_readable_repr std::string to_string(AhoCorasick& ac); diff --git a/include/libsemigroups/detail/rewriters.hpp b/include/libsemigroups/detail/rewriters.hpp index a8fd8dc3d..cb784859f 100644 --- a/include/libsemigroups/detail/rewriters.hpp +++ b/include/libsemigroups/detail/rewriters.hpp @@ -98,7 +98,7 @@ namespace libsemigroups { //! //! \param id the id of the new rule. //! - //! \exception + //! \exceptions //! \no_libsemigroups_except explicit Rule(int64_t id); @@ -124,7 +124,7 @@ namespace libsemigroups { //! //! \returns A pointer to the left-hand side. //! - //! \exception + //! \exceptions //! \noexcept //! //! \complexity @@ -144,7 +144,7 @@ namespace libsemigroups { //! //! \returns A pointer to the right-hand side. //! - //! \exception + //! \exceptions //! \noexcept //! //! \complexity @@ -163,7 +163,7 @@ namespace libsemigroups { //! //! \returns A value of type `bool`. //! - //! \exception + //! \exceptions //! \noexcept //! //! \complexity @@ -178,7 +178,7 @@ namespace libsemigroups { //! //! \returns A value of type `bool`. //! - //! \exception + //! \exceptions //! \noexcept //! //! \complexity @@ -196,7 +196,7 @@ namespace libsemigroups { //! //! Deactivate a rule, if it is active. //! - //! \exception + //! \exceptions //! \noexcept //! //! \complexity @@ -210,7 +210,7 @@ namespace libsemigroups { //! //! Activate a rule, if it is inactive. //! - //! \exception + //! \exceptions //! \noexcept //! //! \complexity @@ -226,7 +226,7 @@ namespace libsemigroups { //! //! \param id the id to set. //! - //! \exception + //! \exceptions //! \noexcept //! //! \complexity @@ -269,7 +269,7 @@ namespace libsemigroups { //! \complexity //! Constant. //! - //! \exception + //! \exceptions //! \noexcept [[nodiscard]] int64_t id() const noexcept { LIBSEMIGROUPS_ASSERT(_id != 0); diff --git a/include/libsemigroups/transf.hpp b/include/libsemigroups/transf.hpp index a89144919..8e637210b 100644 --- a/include/libsemigroups/transf.hpp +++ b/include/libsemigroups/transf.hpp @@ -149,7 +149,7 @@ namespace libsemigroups { //! \returns //! A value of type \ref point_type. //! - //! \exception + //! \exceptions //! \noexcept [[nodiscard]] static point_type undef() noexcept { return static_cast(UNDEFINED); diff --git a/include/libsemigroups/word-graph.hpp b/include/libsemigroups/word-graph.hpp index ebaff60d1..682b16b49 100644 --- a/include/libsemigroups/word-graph.hpp +++ b/include/libsemigroups/word-graph.hpp @@ -640,7 +640,7 @@ namespace libsemigroups { //! \complexity //! Constant. //! - //! \exception LibsemigroupsException if \p source or \p a is not + //! \throws LibsemigroupsException if \p source or \p a is not //! valid. // Not noexcept because throw_if_node_out_of_bounds/label aren't [[nodiscard]] node_type target(node_type source, label_type a) const; @@ -1460,7 +1460,7 @@ namespace libsemigroups { //! \param first iterator into a word. //! \param last iterator into a word. //! - //! \exception + //! \exceptions //! \noexcept //! //! \returns A value of type \p Node1. @@ -1492,7 +1492,7 @@ namespace libsemigroups { //! \param from the source node. //! \param path the word. //! - //! \exception + //! \exceptions //! \noexcept //! //! \returns A value of type \p Node1. @@ -2065,7 +2065,7 @@ namespace libsemigroups { //! \param first iterator into a word. //! \param last iterator into a word. //! - //! \exception + //! \exceptions //! \noexcept //! //! \returns A pair consisting of the last node reached and an iterator