squash w/ [?] Add utility for converting single quotes to their hex e…

…ncoding. Documentation.
korydraughn · Dec 16, 2024 · 81635f8 · 81635f8
1 parent b49d3fe
commit 81635f8
Showing 1 changed file with 2 additions and 0 deletions.
diff --git a/lib/core/include/irods/escape_utilities.hpp b/lib/core/include/irods/escape_utilities.hpp
@@ -7,6 +7,8 @@ namespace irods
 {
     /// Returns a copy of a string with all single quotes replaced by their hexadecimal value.
     ///
+    /// \throws irods::exception If an error occurs while escaping the string.
+    ///
     /// \param[in] _s A string possibly containing single quotes.
     ///
     /// \returns std::string