GNOME.org
 

[glib] gio/ docs fixup

commit 5344c22810c01a0cd708562be563f81f15f517f3
Author: Ryan Lortie <desrt desrt ca>
Date:   Mon Jul 12 18:30:14 2010 -0400

    gio/ docs fixup

 docs/reference/gio/Makefile.am            |    5 ++
 docs/reference/gio/gio-sections.txt       |   32 +--------------
 docs/reference/glib/tmpl/glib-unused.sgml |   59 +++++++++++++++--------------
 gio/fen/fen-kernel.c                      |    6 +-
 gio/fen/fen-node.c                        |    8 ++--
 gio/fen/libfen_la-fen-dump.loT            |    7 ---
 gio/gappinfo.h                            |    1 -
 gio/gbufferedoutputstream.h               |    1 -
 gio/gconverterinputstream.h               |    1 -
 gio/gconverteroutputstream.h              |    1 -
 gio/gdatainputstream.h                    |    1 -
 gio/gdataoutputstream.h                   |    1 -
 gio/gfileenumerator.h                     |    1 -
 gio/gkeyfilesettingsbackend.c             |    2 +-
 gio/gsettings.c                           |    8 ++--
 gio/gsettings.h                           |    2 +-
 gio/gsettingsschema.c                     |    2 +-
 gio/gunixconnection.c                     |    2 +-
 gio/gvolumemonitor.h                      |    1 -
 19 files changed, 53 insertions(+), 88 deletions(-)
---
diff --git a/docs/reference/gio/Makefile.am b/docs/reference/gio/Makefile.am
index ca9c84f..f012382 100644
--- a/docs/reference/gio/Makefile.am
+++ b/docs/reference/gio/Makefile.am
@@ -18,6 +18,8 @@ CFILE_GLOB=$(top_srcdir)/gio/*.c
 
 # Headers to ignore
 IGNORE_HFILES=				\
+	gvdb				\
+	tests				\
 	asyncns.h			\
 	fam-helper.h			\
 	fen-data.h			\
@@ -59,6 +61,7 @@ IGNORE_HFILES=				\
 	glocalfilemonitor.h		\
 	glocalfileoutputstream.h	\
 	glocalvfs.h			\
+	gmemorysettingsbackend.h	\
 	gnativevolumemonitor.h		\
 	gnetworkingprivate.h		\
 	gnullsettingsbackend.h		\
@@ -66,6 +69,8 @@ IGNORE_HFILES=				\
 	gsettingsbackendinternal.h	\
 	gsettingsschema.h		\
 	gsettings-mapping.h		\
+	gsocketinputstream.h		\
+	gsocketoutputstream.h		\
 	gthreadedresolver.h		\
 	gunionvolumemonitor.h		\
 	gunixdrive.h			\
diff --git a/docs/reference/gio/gio-sections.txt b/docs/reference/gio/gio-sections.txt
index 20bb3c4..f44de5b 100644
--- a/docs/reference/gio/gio-sections.txt
+++ b/docs/reference/gio/gio-sections.txt
@@ -378,6 +378,7 @@ G_TYPE_FILE_INFO
 G_FILE_INFO_CLASS
 G_IS_FILE_INFO_CLASS
 G_FILE_INFO_GET_CLASS
+g_file_attribute_matcher_get_type
 <SUBSECTION Private>
 g_file_info_get_type
 </SECTION>
@@ -1194,6 +1195,7 @@ g_io_scheduler_job_send_to_mainloop_async
 G_IO_ERROR
 GIOErrorEnum
 g_io_error_from_errno
+g_io_error_from_win32_error
 <SUBSECTION Private>
 g_io_error_quark
 </SECTION>
@@ -1910,7 +1912,6 @@ G_IS_SOCKET_LISTENER_CLASS
 G_SOCKET_LISTENER
 G_SOCKET_LISTENER_CLASS
 G_SOCKET_LISTENER_GET_CLASS
-G_TYPE_SOCKET_INPUT_STREAM
 G_TYPE_SOCKET_LISTENER
 <SUBSECTION Private>
 GSocketListenerPrivate
@@ -2116,6 +2117,7 @@ g_settings_backend_keys_changed
 g_settings_backend_path_writable_changed
 g_settings_backend_writable_changed
 g_settings_backend_changed_tree
+g_settings_backend_flatten_tree
 g_keyfile_settings_backend_new
 
 <SUBSECTION Standard>
@@ -2188,14 +2190,9 @@ GSettingsBindGetMapping
 GSettingsClass
 G_IS_SETTINGS
 G_IS_SETTINGS_CLASS
-G_IS_SETTINGS_SCHEMA
-G_IS_SETTINGS_SCHEMA_CLASS
 G_SETTINGS
 G_SETTINGS_CLASS
 G_SETTINGS_GET_CLASS
-G_SETTINGS_SCHEMA
-G_SETTINGS_SCHEMA_CLASS
-G_SETTINGS_SCHEMA_GET_CLASS
 G_TYPE_SETTINGS
 
 <SUBSECTION Private>
@@ -2278,11 +2275,7 @@ g_dbus_auth_observer_authorize_authenticated_peer
 G_DBUS_AUTH_OBSERVER
 G_IS_DBUS_AUTH_OBSERVER
 G_TYPE_DBUS_AUTH_OBSERVER
-G_DBUS_AUTH_OBSERVER_CLASS
-G_IS_DBUS_AUTH_OBSERVER_CLASS
-G_DBUS_AUTH_OBSERVER_GET_CLASS
 <SUBSECTION Private>
-GDBusAuthObserverPrivate
 g_dbus_auth_observer_get_type
 </SECTION>
 
@@ -2302,11 +2295,7 @@ g_dbus_server_get_client_address
 G_DBUS_SERVER
 G_IS_DBUS_SERVER
 G_TYPE_DBUS_SERVER
-G_DBUS_SERVER_CLASS
-G_IS_DBUS_SERVER_CLASS
-G_DBUS_SERVER_GET_CLASS
 <SUBSECTION Private>
-GDBusServerPrivate
 g_dbus_server_get_type
 </SECTION>
 
@@ -2365,11 +2354,7 @@ g_dbus_message_to_gerror
 G_DBUS_MESSAGE
 G_IS_DBUS_MESSAGE
 G_TYPE_DBUS_MESSAGE
-G_DBUS_MESSAGE_CLASS
-G_IS_DBUS_MESSAGE_CLASS
-G_DBUS_MESSAGE_GET_CLASS
 <SUBSECTION Private>
-GDBusMessagePrivate
 g_dbus_message_get_type
 </SECTION>
 
@@ -2434,11 +2419,7 @@ g_dbus_connection_unregister_subtree
 G_DBUS_CONNECTION
 G_IS_DBUS_CONNECTION
 G_TYPE_DBUS_CONNECTION
-G_DBUS_CONNECTION_CLASS
-G_IS_DBUS_CONNECTION_CLASS
-G_DBUS_CONNECTION_GET_CLASS
 <SUBSECTION Private>
-GDBusConnectionPrivate
 g_dbus_connection_get_type
 </SECTION>
 
@@ -2466,11 +2447,7 @@ g_dbus_method_invocation_return_dbus_error
 G_DBUS_METHOD_INVOCATION
 G_IS_DBUS_METHOD_INVOCATION
 G_TYPE_DBUS_METHOD_INVOCATION
-G_DBUS_METHOD_INVOCATION_CLASS
-G_IS_DBUS_METHOD_INVOCATION_CLASS
-G_DBUS_METHOD_INVOCATION_GET_CLASS
 <SUBSECTION Private>
-GDBusMethodInvocationPrivate
 g_dbus_method_invocation_get_type
 </SECTION>
 
@@ -2643,10 +2620,7 @@ g_simple_permission_new
 
 <SUBSECTION Standard>
 G_SIMPLE_PERMISSION
-G_SIMPLE_PERMISSION_CLASS
-G_SIMPLE_PERMISSION_GET_CLASS
 G_IS_SIMPLE_PERMISSION
-G_IS_SIMPLE_PERMISSION_CLASS
 G_TYPE_SIMPLE_PERMISSION
 
 <SUBSECTION Private>
diff --git a/docs/reference/glib/tmpl/glib-unused.sgml b/docs/reference/glib/tmpl/glib-unused.sgml
index fbd081d..3d551f7 100644
--- a/docs/reference/glib/tmpl/glib-unused.sgml
+++ b/docs/reference/glib/tmpl/glib-unused.sgml
@@ -48,6 +48,34 @@ Desktop Entry Parser
 
 
 
+<!-- ##### SECTION ./tmpl/limits.sgml.sgml:Image ##### -->
+
+
+
+<!-- ##### SECTION ./tmpl/limits.sgml.sgml:Long_Description ##### -->
+<para>
+
+</para>
+
+
+<!-- ##### SECTION ./tmpl/limits.sgml.sgml:See_Also ##### -->
+<para>
+
+</para>
+
+
+<!-- ##### SECTION ./tmpl/limits.sgml.sgml:Short_Description ##### -->
+
+
+
+<!-- ##### SECTION ./tmpl/limits.sgml.sgml:Stability_Level ##### -->
+
+
+
+<!-- ##### SECTION ./tmpl/limits.sgml.sgml:Title ##### -->
+Version Information
+
+
 <!-- ##### SECTION ./tmpl/testutils.sgml:Long_Description ##### -->
 <para>
 
@@ -911,9 +939,7 @@ Turns the argument into a string literal by using the '#' stringizing operator.
 
 <!-- ##### VARIABLE glib_binary_age ##### -->
 <para>
-This is the binary age passed to <application>libtool</application>. If 
-<application>libtool</application> means nothing to you, don't worry 
-about it. ;-)
+
 </para>
 
 
@@ -929,50 +955,25 @@ about it. ;-)
 
 <!-- ##### VARIABLE glib_interface_age ##### -->
 <para>
-This is the interface age passed to <application>libtool</application>. If 
-<application>libtool</application> means nothing to you, don't worry 
-about it. ;-)
+
 </para>
 
 
 <!-- ##### VARIABLE glib_major_version ##### -->
 <para>
-The major version number of the GLib library. 
-(e.g. in GLib version 1.2.5 this is 1.)
-</para>
 
-<para>
-This variable is in the library, so represents the
-GLib library you have linked against. Contrast with the
-#GLIB_MAJOR_VERSION macro, which represents the major version of the
-GLib headers you have included.
 </para>
 
 
 <!-- ##### VARIABLE glib_micro_version ##### -->
 <para>
-The micro version number of the GLib library.
-(e.g. in GLib version 1.2.5 this is 5.)
-</para>
 
-<para>
-This variable is in the library, so represents the GLib library you
-have linked against. Contrast with the #GLIB_MICRO_VERSION macro, which
-represents the micro version of the GLib headers you have included.
 </para>
 
 
 <!-- ##### VARIABLE glib_minor_version ##### -->
 <para>
-The minor version number of the GLib library.
-(e.g. in GLib version 1.2.5 this is 2.)
-</para>
 
-<para>
-This variable is in the library, so represents the
-GLib library you have linked against. Contrast with the
-#GLIB_MINOR_VERSION macro, which represents the minor version of the
-GLib headers you have included.
 </para>
 
 
diff --git a/gio/fen/fen-kernel.c b/gio/fen/fen-kernel.c
index 2649e95..a060016 100644
--- a/gio/fen/fen-kernel.c
+++ b/gio/fen/fen-kernel.c
@@ -302,7 +302,7 @@ psource_new()
 	return source;
 }
 
-/**
+/*
  * port_add:
  * @f:
  *
@@ -374,7 +374,7 @@ start_over:
     return errno;
 }
 
-/**
+/*
  * port_remove
  *
  * < private >
@@ -408,7 +408,7 @@ port_remove (node_t *f)
     }
 }
 
-/**
+/*
  * Get Solaris resouce values.
  *
  */
diff --git a/gio/fen/fen-node.c b/gio/fen/fen-node.c
index c151e93..4e39775 100644
--- a/gio/fen/fen-node.c
+++ b/gio/fen/fen-node.c
@@ -243,7 +243,7 @@ node_create_children_snapshot(node_t *f, gint created_event, gboolean emit)
     }
 }
 
-/**
+/*
  * If all active children nodes are ported, then cancel monitor the parent
  * node. If we know how many children are created, then we can stop accordingly.
  *
@@ -373,7 +373,7 @@ node_children_num (node_t *f)
     return g_hash_table_size (f->children);
 }
 
-/**
+/*
  * depth first delete recursively
  */
 static gboolean
@@ -394,7 +394,7 @@ node_class_init()
     return port_class_init (node_add_event);
 }
 
-/**
+/*
  * Adjust self on failing to Port
  */
 void
@@ -481,7 +481,7 @@ node_emit_events(node_t *f, const node_event_t *ne)
     }
 }
 
-/**
+/*
  * node_add_event:
  *
  */
diff --git a/gio/gappinfo.h b/gio/gappinfo.h
index 3746776..fc85107 100644
--- a/gio/gappinfo.h
+++ b/gio/gappinfo.h
@@ -186,7 +186,6 @@ gboolean  g_app_info_launch_default_for_uri      (const char              *uri,
 
 /**
  * GAppLaunchContext:
- * @parent_instance: The parent instance.
  *
  * Integrating the launch with the launching application. This is used to
  * handle for instance startup notification and launching the new application
diff --git a/gio/gbufferedoutputstream.h b/gio/gbufferedoutputstream.h
index 106bca7..0d84790 100644
--- a/gio/gbufferedoutputstream.h
+++ b/gio/gbufferedoutputstream.h
@@ -40,7 +40,6 @@ G_BEGIN_DECLS
 
 /**
  * GBufferedOutputStream:
- * @parent_class: The parent class.
  *
  * An implementation of #GFilterOutputStream with a sized buffer.
  **/
diff --git a/gio/gconverterinputstream.h b/gio/gconverterinputstream.h
index d2ef887..8e4f1d4 100644
--- a/gio/gconverterinputstream.h
+++ b/gio/gconverterinputstream.h
@@ -41,7 +41,6 @@ G_BEGIN_DECLS
 
 /**
  * GConverterInputStream:
- * @parent_interface: a #GFilterInputStream.
  *
  * An implementation of #GFilterInputStream that allows data
  * conversion.
diff --git a/gio/gconverteroutputstream.h b/gio/gconverteroutputstream.h
index afcb74f..ceac200 100644
--- a/gio/gconverteroutputstream.h
+++ b/gio/gconverteroutputstream.h
@@ -41,7 +41,6 @@ G_BEGIN_DECLS
 
 /**
  * GConverterOutputStream:
- * @parent_instance: a #GFilterOutputStream.
  *
  * An implementation of #GFilterOutputStream that allows data
  * conversion.
diff --git a/gio/gdatainputstream.h b/gio/gdatainputstream.h
index c01ef87..0e42317 100644
--- a/gio/gdatainputstream.h
+++ b/gio/gdatainputstream.h
@@ -40,7 +40,6 @@ G_BEGIN_DECLS
 
 /**
  * GDataInputStream:
- * @parent: a #GBufferedInputStream.
  *
  * An implementation of #GBufferedInputStream that allows for high-level
  * data manipulation of arbitrary data (including binary operations).
diff --git a/gio/gdataoutputstream.h b/gio/gdataoutputstream.h
index f864b18..0fb3cbf 100644
--- a/gio/gdataoutputstream.h
+++ b/gio/gdataoutputstream.h
@@ -40,7 +40,6 @@ G_BEGIN_DECLS
 
 /**
  * GDataOutputStream:
- * @parent_instance: a #GBufferedOutputStream.
  *
  * An implementation of #GBufferedOutputStream that allows for high-level
  * data manipulation of arbitrary data (including binary operations).
diff --git a/gio/gfileenumerator.h b/gio/gfileenumerator.h
index 1214b49..a0cfaaf 100644
--- a/gio/gfileenumerator.h
+++ b/gio/gfileenumerator.h
@@ -40,7 +40,6 @@ G_BEGIN_DECLS
 
 /**
  * GFileEnumerator:
- * @parent_instance: The parent class.
  *
  * A per matched file iterator.
  **/
diff --git a/gio/gkeyfilesettingsbackend.c b/gio/gkeyfilesettingsbackend.c
index 14f4384..0741e16 100644
--- a/gio/gkeyfilesettingsbackend.c
+++ b/gio/gkeyfilesettingsbackend.c
@@ -585,7 +585,7 @@ dir_changed (GFileMonitor       *monitor,
  * @root_path: the path under which all settings keys appear
  * @root_group: (allow-none): the group name corresponding to
  *              @root_path, or %NULL
- * Returns: a keyfile-backed #GSettingsBackend
+ * @returns: a keyfile-backed #GSettingsBackend
  *
  * Creates a keyfile-backed #GSettingsBackend.
  *
diff --git a/gio/gsettings.c b/gio/gsettings.c
index 8685de2..5b72540 100644
--- a/gio/gsettings.c
+++ b/gio/gsettings.c
@@ -1507,6 +1507,7 @@ g_settings_set (GSettings   *settings,
  * @mapping: the function to map the value in the settings database to
  *           the value used by the application
  * @user_data: user data for @mapping
+ * @returns: the result, which may be %NULL
  *
  * Gets the value that is stored at @key in @settings, subject to
  * application-level validation/mapping.
@@ -1963,10 +1964,9 @@ g_settings_get_has_unapplied (GSettings *settings)
 /* Extra API (sync, get_child, is_writable, list_items) {{{1 */
 /**
  * g_settings_sync:
- * @context: the context to sync, or %NULL
  *
- * Ensures that all pending operations for the given context are
- * complete.
+ * Ensures that all pending operations for the given are complete for
+ * the default backend.
  *
  * Writes made to a #GSettings are handled asynchronously.  For this
  * reason, it is very unlikely that the changes have it to disk by the
@@ -2056,7 +2056,7 @@ g_settings_get_child (GSettings   *settings,
 /**
  * g_settings_list_items:
  * @settings: a #GSettings object
- * Returns: a list of the keys on @settings
+ * @returns: a list of the keys on @settings
  *
  * Introspects the list of keys and children on @settings.
  *
diff --git a/gio/gsettings.h b/gio/gsettings.h
index 70dbbd8..d70d7fa 100644
--- a/gio/gsettings.h
+++ b/gio/gsettings.h
@@ -178,7 +178,7 @@ typedef gboolean      (*GSettingsBindGetMapping)                        (GValue
  * @value: the #GVariant to map, or %NULL
  * @result: the result of the mapping
  * @user_data: the user data that was passed to g_settings_get_mapped()
- * Returns: %TRUE if the conversion succeeded, %FALSE in case of an error
+ * @returns: %TRUE if the conversion succeeded, %FALSE in case of an error
  *
  * The type of the function that is used to convert from a value stored
  * in a #GSettings to a value that is useful to the application.
diff --git a/gio/gsettingsschema.c b/gio/gsettingsschema.c
index 87506c0..6d8d77a 100644
--- a/gio/gsettingsschema.c
+++ b/gio/gsettingsschema.c
@@ -95,7 +95,7 @@ add_item (gpointer key,
 
 /**
  * g_settings_list_schemas:
- * Returns: a list of the schemas installed on the system
+ * @returns: a list of the schemas installed on the system
  *
  * Returns a list of GSettings schemas that are available.  The list
  * must not be modified or freed.
diff --git a/gio/gunixconnection.c b/gio/gunixconnection.c
index 7626c1f..b5cf136 100644
--- a/gio/gunixconnection.c
+++ b/gio/gunixconnection.c
@@ -131,7 +131,7 @@ g_unix_connection_send_fd (GUnixConnection  *connection,
  * Returns: a file descriptor on success, -1 on error.
  *
  * Since: 2.22
- */
+ **/
 gint
 g_unix_connection_receive_fd (GUnixConnection  *connection,
                               GCancellable     *cancellable,
diff --git a/gio/gvolumemonitor.h b/gio/gvolumemonitor.h
index 9e3bd80..5b47a9f 100644
--- a/gio/gvolumemonitor.h
+++ b/gio/gvolumemonitor.h
@@ -51,7 +51,6 @@ G_BEGIN_DECLS
 
 /**
  * GVolumeMonitor:
- * @parent_instance: The parent instance.
  *
  * A Volume Monitor that watches for volume events.
  **/
[Date Prev][Date Next]   [Thread Prev][Thread Next]   [Thread Index] [Date Index] [Author Index]