Docs improvement

svn path=/trunk/; revision=7801

diff --git a/ChangeLog b/ChangeLog
index 38610a8..9ab43bf 100644 (file)
--- a/ChangeLog
+++ b/ChangeLog
@@ -1,3 +1,10 @@
+2009-01-10  Matthias Clasen  <mclasen@redhat.com>
+
+       Bug 566569 – gregex docs clarification
+
+       * glib/gregex.c: Copy the warning about @string to all
+       relevant docs. Proposed by Christian Persch
+
 2009-01-09  Tor Lillqvist  <tml@iki.fi>
 
        Bug 567138 - get_package_directory_from_module() does not free its

diff --git a/glib/gregex.c b/glib/gregex.c
index 94440ef..6ad873a 100644 (file)
--- a/glib/gregex.c
+++ b/glib/gregex.c
@@ -1351,6 +1351,10 @@ g_regex_match_simple (const gchar        *pattern,
  * }
  * ]|
  *
+ * @string is not copied and is used in #GMatchInfo internally. If 
+ * you use any #GMatchInfo method (except g_match_info_free()) after 
+ * freeing or modifying @string then the behaviour is undefined.
+ *
  * Returns: %TRUE is the string matched, %FALSE otherwise
  *
  * Since: 2.14
@@ -1478,6 +1482,10 @@ g_regex_match_full (const GRegex      *regex,
  * i.e. you must free it regardless if regular expression actually 
  * matched.
  *
+ * @string is not copied and is used in #GMatchInfo internally. If 
+ * you use any #GMatchInfo method (except g_match_info_free()) after 
+ * freeing or modifying @string then the behaviour is undefined.
+ * 
  * Returns: %TRUE is the string matched, %FALSE otherwise
  *
  * Since: 2.14
@@ -1536,6 +1544,10 @@ g_regex_match_all (const GRegex      *regex,
  * i.e. you must free it regardless if regular expression actually 
  * matched.
  *
+ * @string is not copied and is used in #GMatchInfo internally. If 
+ * you use any #GMatchInfo method (except g_match_info_free()) after 
+ * freeing or modifying @string then the behaviour is undefined.
+ *
  * Returns: %TRUE is the string matched, %FALSE otherwise
  *
  * Since: 2.14