summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorAntónio Fernandes <antoniojpfernandes@gmail.com>2018-12-10 23:01:53 +0000
committerAntónio Fernandes <antoniojpfernandes@gmail.com>2018-12-10 23:01:53 +0000
commitc93430f7951521af0c3b5822b8d0043d1fbe3f18 (patch)
tree0b621af7bdac79e2bd5b472892c302218cb3ceb6
parentbdc9328bdf5ebb7f52f947354e2b14fedde0035b (diff)
downloadglib-wip/antoniof/document_grefstring_type.tar.gz
grefstring: Document GRefString typewip/antoniof/document_grefstring_type
This symbol has been added to glib-sections.txt in 93f3202a615a20cf2f1bc038ad31f98a8c232c5a but lacks a gtk-doc comment block. So, let's add it.
-rw-r--r--glib/grefstring.c9
1 files changed, 9 insertions, 0 deletions
diff --git a/glib/grefstring.c b/glib/grefstring.c
index 56a6181fc..728ebff11 100644
--- a/glib/grefstring.c
+++ b/glib/grefstring.c
@@ -300,3 +300,12 @@ g_ref_string_length (char *str)
return g_atomic_rc_box_get_size (str) - 1;
}
+
+/**
+ * GRefString:
+ *
+ * A typedef alias for char. This improves readability when passing reference
+ * counted strings and is useful when used together with g_autoptr().
+ *
+ * Since: 2.58
+ */ \ No newline at end of file