[glib] Doc: fix some gtk-doc warnings
- From: Xavier Claessens <xclaesse src gnome org>
- To: commits-list gnome org
- Cc:
- Subject: [glib] Doc: fix some gtk-doc warnings
- Date: Fri, 30 Oct 2015 14:31:13 +0000 (UTC)
commit 2331437df3fa3c28649f6b318ed980bd9462434f
Author: Xavier Claessens <xavier claessens collabora com>
Date: Mon Sep 21 13:24:44 2015 -0400
Doc: fix some gtk-doc warnings
https://bugzilla.gnome.org/show_bug.cgi?id=755364
docs/reference/glib/glib-sections.txt | 1 +
gio/gfilemonitor.c | 15 +++++++++++++++
gio/gsocketconnectable.h | 2 +-
glib/gmem.c | 3 +++
gobject/gparam.c | 2 +-
gobject/gparam.h | 4 ++--
6 files changed, 23 insertions(+), 4 deletions(-)
---
diff --git a/docs/reference/glib/glib-sections.txt b/docs/reference/glib/glib-sections.txt
index 03cc0a1..aec585e 100644
--- a/docs/reference/glib/glib-sections.txt
+++ b/docs/reference/glib/glib-sections.txt
@@ -2319,6 +2319,7 @@ GSequenceIterCompareFunc
g_sequence_new
g_sequence_free
g_sequence_get_length
+g_sequence_is_empty
g_sequence_foreach
g_sequence_foreach_range
g_sequence_sort
diff --git a/gio/gfilemonitor.c b/gio/gfilemonitor.c
index 71d5f55..b05a896 100644
--- a/gio/gfilemonitor.c
+++ b/gio/gfilemonitor.c
@@ -259,6 +259,21 @@ g_file_monitor_set_rate_limit (GFileMonitor *monitor,
g_object_set (monitor, "rate-limit", limit_msecs, NULL);
}
+/**
+ * g_file_monitor_emit_event:
+ * @monitor: a #GFileMonitor.
+ * @child: a #GFile.
+ * @other_file: a #GFile.
+ * @event_type: a set of #GFileMonitorEvent flags.
+ *
+ * Emits the #GFileMonitor::changed signal if a change
+ * has taken place. Should be called from file monitor
+ * implementations only.
+ *
+ * Implementations are responsible to call this method from the
+ * [thread-default main context][g-main-context-push-thread-default] of the
+ * thread that the monitor was created in.
+ **/
void
g_file_monitor_emit_event (GFileMonitor *monitor,
GFile *child,
diff --git a/gio/gsocketconnectable.h b/gio/gsocketconnectable.h
index 45b5450..25805b7 100644
--- a/gio/gsocketconnectable.h
+++ b/gio/gsocketconnectable.h
@@ -73,7 +73,7 @@ GLIB_AVAILABLE_IN_ALL
GSocketAddressEnumerator *g_socket_connectable_proxy_enumerate (GSocketConnectable *connectable);
GLIB_AVAILABLE_IN_2_48
-gchar *g_socket_connectable_to_string (GSocketConnectable *addr);
+gchar *g_socket_connectable_to_string (GSocketConnectable *connectable);
G_END_DECLS
diff --git a/glib/gmem.c b/glib/gmem.c
index c76ae17..7595ec0 100644
--- a/glib/gmem.c
+++ b/glib/gmem.c
@@ -486,6 +486,9 @@ g_mem_set_vtable (GMemVTable *vtable)
/**
* glib_mem_profiler_table:
*
+ * Used to be a #GMemVTable containing profiling variants of the memory
+ * allocation functions, but this variable shouldn't be modified anymore.
+ *
* Deprecated: 2.46: Use other memory profiling tools instead
*/
GMemVTable *glib_mem_profiler_table = &glib_mem_vtable;
diff --git a/gobject/gparam.c b/gobject/gparam.c
index 020834f..e26482c 100644
--- a/gobject/gparam.c
+++ b/gobject/gparam.c
@@ -1572,7 +1572,7 @@ g_param_spec_get_default_value (GParamSpec *pspec)
/**
* g_param_spec_get_name_quark:
- * @param: a #GParamSpec
+ * @pspec: a #GParamSpec
*
* Gets the GQuark for the name.
*
diff --git a/gobject/gparam.h b/gobject/gparam.h
index 612624c..e2bd286 100644
--- a/gobject/gparam.h
+++ b/gobject/gparam.h
@@ -341,10 +341,10 @@ GLIB_DEPRECATED_FOR(g_value_take_param)
void g_value_set_param_take_ownership (GValue *value,
GParamSpec *param);
GLIB_AVAILABLE_IN_2_36
-const GValue * g_param_spec_get_default_value (GParamSpec *param);
+const GValue * g_param_spec_get_default_value (GParamSpec *pspec);
GLIB_AVAILABLE_IN_2_46
-GQuark g_param_spec_get_name_quark (GParamSpec *param);
+GQuark g_param_spec_get_name_quark (GParamSpec *pspec);
/* --- convenience functions --- */
typedef struct _GParamSpecTypeInfo GParamSpecTypeInfo;
[
Date Prev][
Date Next] [
Thread Prev][
Thread Next]
[
Thread Index]
[
Date Index]
[
Author Index]