[gtksourceview] docs: fix escape sequences in utils functions



commit cdff933bc00f21d5f1048f1136e56b0a91139c83
Author: Matthew Leeds <mleeds redhat com>
Date:   Sat Jun 25 13:57:39 2016 -0400

    docs: fix escape sequences in utils functions
    
    gtk-doc treats backslash as the escape character, so devhelp displays
    "\." as "." and "\\" as "\". In the documentation for
    gtk_source_utils_escape_search_text() and
    gtk_source_utils_unescape_search_text(), we want to display "\" and "\\"
    literally so they have to be surrounded by backticks.
    
    https://bugzilla.gnome.org/show_bug.cgi?id=768040

 gtksourceview/gtksourceutils.c |    4 ++--
 1 files changed, 2 insertions(+), 2 deletions(-)
---
diff --git a/gtksourceview/gtksourceutils.c b/gtksourceview/gtksourceutils.c
index afa0eab..3683466 100644
--- a/gtksourceview/gtksourceutils.c
+++ b/gtksourceview/gtksourceutils.c
@@ -40,7 +40,7 @@
  * @text: the text to unescape.
  *
  * Use this function before gtk_source_search_settings_set_search_text(), to
- * unescape the following sequences of characters: \n, \r, \t and \\.
+ * unescape the following sequences of characters: `\n`, `\r`, `\t` and `\\`.
  * The purpose is to easily write those characters in a search entry.
  *
  * Note that unescaping the search text is not needed for regular expression
@@ -131,7 +131,7 @@ gtk_source_utils_unescape_search_text (const gchar *text)
  * gtk_source_utils_escape_search_text:
  * @text: the text to escape.
  *
- * Use this function to escape the following characters: \n, \r, \t and \.
+ * Use this function to escape the following characters: `\n`, `\r`, `\t` and `\`.
  *
  * For a regular expression search, use g_regex_escape_string() instead.
  *


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