[glibmm/glibmm-2-64] Glib::Regex docs: Clarify the deprecation of match() and match_all()



commit a219a227cdd05f64c98d606b6f94672ab51c9faf
Author: Kjell Ahlstedt <kjellahlstedt gmail com>
Date:   Tue Mar 17 11:36:15 2020 +0100

    Glib::Regex docs: Clarify the deprecation of match() and match_all()
    
    See MR !26

 glib/src/regex.hg | 13 ++++++++++---
 1 file changed, 10 insertions(+), 3 deletions(-)
---
diff --git a/glib/src/regex.hg b/glib/src/regex.hg
index ea42792b..ce85c95a 100644
--- a/glib/src/regex.hg
+++ b/glib/src/regex.hg
@@ -94,7 +94,8 @@ class GLIBMM_API MatchInfo;
  * use a Glib::ustring that still exists when you later call MatchInfo methods.
  * If you call match() or match_all() with a std::string or a string literal,
  * the method will internally use a temporary copy of the string. The copy will
- * not exist when you call MatchInfo methods.
+ * not exist when you call MatchInfo methods. The use of temporary string values
+ * is deprecated in all match() and match_all() methods since glibmm 2.64.
  * @code
  * Glib::ustring str1 = "String to search through";
  * regex->match(str1, match_info);
@@ -166,7 +167,10 @@ public:
   bool match(const Glib::ustring& string, gssize string_len, int start_position, RegexMatchFlags 
match_options);
 
 #if defined(GLIBMM_DISABLE_DEPRECATED) || defined(DOXYGEN_SHOULD_SKIP_THIS)
-  /// @deprecated Disallow rvalue references, such as temporary values.
+  /** Rvalue references, such as temporary values, are deprecated.
+   * This declaration is enabled if the preprocessor constant
+   * GLIBMM_DISABLE_DEPRECATED is defined.
+   */
   bool match(Glib::ustring&& string, ...) = delete;
 #endif // GLIBMM_DISABLE_DEPRECATED || DOXYGEN_SHOULD_SKIP_THIS
 
@@ -211,7 +215,10 @@ public:
   bool match_all(const Glib::ustring& string, gssize string_len, int start_position, RegexMatchFlags 
match_options);
 
 #if defined(GLIBMM_DISABLE_DEPRECATED) || defined(DOXYGEN_SHOULD_SKIP_THIS)
-  /// @deprecated Disallow rvalue references, such as temporary values.
+  /** Rvalue references, such as temporary values, are deprecated.
+   * This declaration is enabled if the preprocessor constant
+   * GLIBMM_DISABLE_DEPRECATED is defined.
+   */
   bool match_all(Glib::ustring&& string, ...) = delete;
 #endif // GLIBMM_DISABLE_DEPRECATED || DOXYGEN_SHOULD_SKIP_THIS
 


[Date Prev][Date Next]   [Thread Prev][Thread Next]   [Thread Index] [Date Index] [Author Index]