From 66441a4d2fcb7d4698c9fe2fafeb71e7406d0f79 Mon Sep 17 00:00:00 2001 From: Michael Davidsaver Date: Thu, 26 Jan 2023 08:51:10 -0800 Subject: [PATCH] doc --- documentation/details.rst | 2 +- src/pvxs/data.h | 2 +- src/pvxs/util.h | 5 ++--- 3 files changed, 4 insertions(+), 5 deletions(-) diff --git a/documentation/details.rst b/documentation/details.rst index 8d4b302..ad09ed3 100644 --- a/documentation/details.rst +++ b/documentation/details.rst @@ -131,7 +131,7 @@ When changing c++ code please do: * Indent with 4 spaces. No hard tabs. UNIX style EoL. * Try to maintain the style of surrounding code. * Include meaningful code comments where reasonable. -* Add doxygen tags ``@since UNRELEASED`` or ``@until UNRELEASED`` when documenting additions/changes to public APIs. +* Add doxygen tags ``@since UNRELEASED`` when documenting additions/changes to public APIs. but do not: diff --git a/src/pvxs/data.h b/src/pvxs/data.h index 283b3b2..becf4dc 100644 --- a/src/pvxs/data.h +++ b/src/pvxs/data.h @@ -734,7 +734,7 @@ public: * * @throws LookupError If the lookup can not be satisfied * @throws NoField If this Value is empty - * @until UNRELEASED An empty Value incorrectly returned an empty Value instead of throwing NoField + * @since UNRELEASED An empty Value correctly throws NoField instead of returning an empty Value */ Value lookup(const std::string& name); const Value lookup(const std::string& name) const; diff --git a/src/pvxs/util.h b/src/pvxs/util.h index a96feb7..ffcfdff 100644 --- a/src/pvxs/util.h +++ b/src/pvxs/util.h @@ -98,9 +98,8 @@ std::ostream& operator<<(std::ostream&, const ServerGUID&); * Saves existing handler, which are restored by dtor. * * @since 1.1.0 "handler" action runs in thread context. - * Safe to take locks etc. - * - * @until 1.1.0 handler action really runs in signal handler context. + * Safe to take locks etc. + * Previously handler action ran in signal handler context. */ class PVXS_API SigInt { public: