[glib] Improve documentation
- From: Sébastien Wilmet <swilmet src gnome org>
- To: commits-list gnome org
- Cc:
- Subject: [glib] Improve documentation
- Date: Sat, 20 Jul 2013 09:08:28 +0000 (UTC)
commit b3968fb1501bb2950e6c15aad95083e6f01973ba
Author: Sébastien Wilmet <swilmet gnome org>
Date: Fri Jul 5 13:23:11 2013 +0200
Improve documentation
- Mention G_SOURCE_CONTINUE and G_SOURCE_REMOVE in the GSourceFunc doc;
- Mention G_PARAM_READWRITE and G_PARAM_STATIC_STRINGS in the
GParamFlags doc;
- Fix "Since:" version for G_DEFINE_ABSTRACT_TYPE_WITH_PRIVATE;
- Fix typo.
https://bugzilla.gnome.org/show_bug.cgi?id=704250
glib/gmain.h | 3 ++-
glib/gregex.h | 2 +-
gobject/gparam.h | 2 +-
gobject/gtype.h | 2 +-
4 files changed, 5 insertions(+), 4 deletions(-)
---
diff --git a/glib/gmain.h b/glib/gmain.h
index d6370fa..558910a 100644
--- a/glib/gmain.h
+++ b/glib/gmain.h
@@ -149,7 +149,8 @@ typedef struct _GSourceFuncs GSourceFuncs;
* Specifies the type of function passed to g_timeout_add(),
* g_timeout_add_full(), g_idle_add(), and g_idle_add_full().
*
- * Returns: %FALSE if the source should be removed
+ * Returns: %FALSE if the source should be removed. #G_SOURCE_CONTINUE and
+ * #G_SOURCE_REMOVE are more memorable names for the return value.
*/
typedef gboolean (*GSourceFunc) (gpointer user_data);
diff --git a/glib/gregex.h b/glib/gregex.h
index c232eac..57fcb67 100644
--- a/glib/gregex.h
+++ b/glib/gregex.h
@@ -372,7 +372,7 @@ typedef enum
* @G_REGEX_MATCH_PARTIAL_HARD: Turns on the partial matching feature. In contrast to
* to #G_REGEX_MATCH_PARTIAL_SOFT, this stops matching as soon as a partial match
* is found, without continuing to search for a possible complete match. See
- * see g_match_info_is_partial_match() for more information. Since: 2.34
+ * g_match_info_is_partial_match() for more information. Since: 2.34
* @G_REGEX_MATCH_NOTEMPTY_ATSTART: Like #G_REGEX_MATCH_NOTEMPTY, but only applied to
* the start of the matched string. For anchored
* patterns this can only happen for pattern containing "\K". Since: 2.34
diff --git a/gobject/gparam.h b/gobject/gparam.h
index b35ad51..7e734e3 100644
--- a/gobject/gparam.h
+++ b/gobject/gparam.h
@@ -138,7 +138,7 @@ G_BEGIN_DECLS
* Since 2.26
*
* Through the #GParamFlags flag values, certain aspects of parameters
- * can be configured.
+ * can be configured. See also #G_PARAM_READWRITE and #G_PARAM_STATIC_STRINGS.
*/
typedef enum
{
diff --git a/gobject/gtype.h b/gobject/gtype.h
index b0a4fba..a10316a 100644
--- a/gobject/gtype.h
+++ b/gobject/gtype.h
@@ -1396,7 +1396,7 @@ guint g_type_get_type_registration_serial (void);
* Similar to G_DEFINE_TYPE_WITH_PRIVATE(), but defines an abstract type.
* See G_DEFINE_TYPE_EXTENDED() for an example.
*
- * Since: 2.4
+ * Since: 2.38
*/
#define G_DEFINE_ABSTRACT_TYPE_WITH_PRIVATE(TN, t_n, T_P) G_DEFINE_TYPE_EXTENDED (TN, t_n, T_P,
G_TYPE_FLAG_ABSTRACT, G_ADD_PRIVATE (TN))
/**
[
Date Prev][
Date Next] [
Thread Prev][
Thread Next]
[
Thread Index]
[
Date Index]
[
Author Index]