luc14n0/glib
1
0
Fork 0
mirror of https://gitlab.gnome.org/GNOME/glib.git synced 2025-01-11 15:06:14 +01:00
Code Issues Packages Projects Releases Wiki Activity

Improve documentation

Browse Source 
- 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
This commit is contained in:
Sébastien Wilmet 2013-07-05 13:23:11 +02:00
parent 8753df9d70
commit b3968fb150
4 changed files with 5 additions and 4 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

3
glib/gmain.h
View File

@ -149,7 +149,8 @@ typedef struct _GSourceFuncs GSourceFuncs;
* Specifies the type of function passed to g_timeout_add(), * Specifies the type of function passed to g_timeout_add(),
* g_timeout_add_full(), g_idle_add(), and g_idle_add_full(). * 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); typedef gboolean (*GSourceFunc) (gpointer user_data);

2
glib/gregex.h
View File

@ -372,7 +372,7 @@ typedef enum
* @G_REGEX_MATCH_PARTIAL_HARD: Turns on the partial matching feature. In contrast to * @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 * 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 * 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 * @G_REGEX_MATCH_NOTEMPTY_ATSTART: Like #G_REGEX_MATCH_NOTEMPTY, but only applied to
* the start of the matched string. For anchored * the start of the matched string. For anchored
* patterns this can only happen for pattern containing "\K". Since: 2.34 * patterns this can only happen for pattern containing "\K". Since: 2.34

2
gobject/gparam.h
View File

@ -138,7 +138,7 @@ G_BEGIN_DECLS
* Since 2.26 * Since 2.26
* *
* Through the #GParamFlags flag values, certain aspects of parameters * 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 typedef enum
{ {

2
gobject/gtype.h
View File

@ -1396,7 +1396,7 @@ guint g_type_get_type_registration_serial (void);
* Similar to G_DEFINE_TYPE_WITH_PRIVATE(), but defines an abstract type. * Similar to G_DEFINE_TYPE_WITH_PRIVATE(), but defines an abstract type.
* See G_DEFINE_TYPE_EXTENDED() for an example. * 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)) #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))
/** /**