Minor documentation additions and corrections

Going for 100%.
This commit is contained in:
Matthias Clasen 2014-05-31 09:04:11 -04:00
parent f38b438c96
commit ab18d71e6f
11 changed files with 101 additions and 19 deletions

View File

@ -54,6 +54,8 @@
* @G_THREAD_PRIORITY_HIGH: a priority higher than normal
* @G_THREAD_PRIORITY_URGENT: the highest priority
*
* Thread priorities.
*
* Deprecated:2.32: Thread priorities no longer have any effect.
*/

View File

@ -2294,6 +2294,12 @@
* Since: 2.4
*/
/**
* G_HAVE_GNUC_VISIBILITY:
*
* Defined to 1 if gcc-style visibility handling is supported.
*/
/* Windows Compatibility Functions {{{1 */
/**

View File

@ -69,11 +69,10 @@ GLIB_AVAILABLE_IN_ALL
GQuark g_convert_error_quark (void);
/**
* GIconv:
* GIConv:
*
* The <structname>GIConv</structname> struct wraps an
* iconv() conversion descriptor. It contains private data
* and should only be accessed using the following functions.
* The GIConv struct wraps an iconv() conversion descriptor. It contains
* private data and should only be accessed using the following functions.
*/
typedef struct _GIConv *GIConv;

View File

@ -942,7 +942,7 @@ g_io_channel_get_line_term (GIOChannel *channel,
* This flag cannot be changed.
* @G_IO_FLAG_IS_WRITABLE: indicates that the io channel is writable.
* This flag cannot be changed.
* G_IO_FLAG_IS_WRITEABLE: a misspelled version of @G_IO_FLAG_IS_WRITABLE
* @G_IO_FLAG_IS_WRITEABLE: a misspelled version of @G_IO_FLAG_IS_WRITABLE
* that existed before the spelling was fixed in GLib 2.30. It is kept
* here for compatibility reasons. Deprecated since 2.30
* @G_IO_FLAG_IS_SEEKABLE: indicates that the io channel is seekable,
@ -2529,11 +2529,6 @@ g_io_channel_write_unichar (GIOChannel *channel,
return status;
}
/**
* g_io_channel_error_quark:
*
* Returns: the quark used as %G_IO_CHANNEL_ERROR
**/
/**
* G_IO_CHANNEL_ERROR:
*

View File

@ -154,6 +154,13 @@
* levels using g_log_set_handler() and g_log_set_fatal_mask().
*/
/**
* G_LOG_LEVEL_USER_SHIFT:
*
* Log levels below 1<<G_LOG_LEVEL_USER_SHIFT are used by GLib.
* Higher bits can be used for user-defined log levels.
*/
/**
* g_message:
* @...: format string, followed by parameters to insert

View File

@ -90,7 +90,9 @@ typedef gint (*GPollFunc) (GPollFD *ufds,
struct _GPollFD
{
#if defined (G_OS_WIN32) && GLIB_SIZEOF_VOID_P == 8
#ifndef __GTK_DOC_IGNORE__
gint64 fd;
#endif
#else
gint fd;
#endif
@ -98,6 +100,12 @@ struct _GPollFD
gushort revents;
};
/**
* G_POLLFD_FORMAT:
*
* A format specifier that can be used in printf()-style format strings
* when printing the @fd member of a #GPollFD.
*/
#ifdef G_OS_WIN32
#if GLIB_SIZEOF_VOID_P == 8
#define G_POLLFD_FORMAT "%#I64x"

View File

@ -292,7 +292,8 @@ GQuark g_regex_error_quark (void);
* Since: 2.14
*/
/* Remember to update G_REGEX_COMPILE_MASK in gregex.c after
* adding a new flag. */
* adding a new flag.
*/
typedef enum
{
G_REGEX_CASELESS = 1 << 0,
@ -405,14 +406,20 @@ typedef enum
/**
* GRegex:
*
* A GRegex is the "compiled" form of a regular expression pattern. This
* structure is opaque and its fields cannot be accessed directly.
* A GRegex is the "compiled" form of a regular expression pattern.
* This structure is opaque and its fields cannot be accessed directly.
*
* Since: 2.14
*/
typedef struct _GRegex GRegex;
/**
* GMatchInfo:
*
* A GMatchInfo is an opaque struct used to return information about
* matches.
*/
typedef struct _GMatchInfo GMatchInfo;
/**

View File

@ -87,6 +87,14 @@
* in #GScannerConfig.
*/
/**
* G_CSET_DIGITS:
*
* The set of ASCII digits.
* Used for specifying valid identifier characters
* in #GScannerConfig.
*/
/**
* G_CSET_LATINC:
*

View File

@ -74,6 +74,8 @@ G_DEFINE_QUARK (g-variant-parse-error-quark, g_variant_parse_error)
/**
* g_variant_parser_get_error_quark:
*
* Same as g_variant_error_quark().
*
* Deprecated: Use g_variant_parse_error_quark() instead.
*/
GQuark

View File

@ -48,6 +48,15 @@
* GLib whose API you want to use.
*/
/**
* glib_major_version:
*
* The major version of the GLib library.
*
* An integer variable exported from the library linked
* against at application run time.
*/
/**
* GLIB_MAJOR_VERSION:
*
@ -58,6 +67,15 @@
* linked against at application run time.
*/
/**
* glib_minor_version:
*
* The minor version number of the GLib library.
*
* An integer variable exported from the library linked
* against at application run time.
*/
/**
* GLIB_MINOR_VERSION:
*
@ -68,6 +86,15 @@
* linked against at application run time.
*/
/**
* glib_micro_version:
*
* The micro version number of the GLib library.
*
* An integer variable exported from the library linked
* against at application run time.
*/
/**
* GLIB_MICRO_VERSION:
*
@ -91,6 +118,26 @@
* is the same as or newer than the passed-in version.
*/
/**
* glib_binary_age:
*
* The binary age of the GLib library.
* Defines how far back backwards compatibility reaches.
*
* An integer variable exported from the library linked
* against at application run time.
*/
/**
* glib_interface_age:
*
* The interface age of the GLib library.
* Defines how far back the API has last been extended.
*
* An integer variable exported from the library linked
* against at application run time.
*/
const guint glib_major_version = GLIB_MAJOR_VERSION;
const guint glib_minor_version = GLIB_MINOR_VERSION;
const guint glib_micro_version = GLIB_MICRO_VERSION;

View File

@ -296,12 +296,13 @@ g_value_fits_pointer (const GValue *value)
/**
* g_value_peek_pointer:
* @value: An initialized #GValue structure.
* @value: An initialized #GValue structure
*
* Returns: (transfer none): the value contents as pointer. This
* function asserts that g_value_fits_pointer() returned %TRUE for the
* passed in value. This is an internal function introduced mainly
* for C marshallers.
* Returns the value contents as pointer. This function asserts that
* g_value_fits_pointer() returned %TRUE for the passed in value.
* This is an internal function introduced mainly for C marshallers.
*
* Returns: (transfer none): the value contents as pointer
*/
gpointer
g_value_peek_pointer (const GValue *value)