Documentation updates

svn path=/trunk/; revision=6336

diff --git a/docs/reference/ChangeLog b/docs/reference/ChangeLog
index 6e5fbebaf39d7b9a988c7ab1d7350949011d2225..c56029b73e46d9b73ec29a09493ef951e5971cac 100644 (file)
--- a/docs/reference/ChangeLog
+++ b/docs/reference/ChangeLog
@@ -1,3 +1,7 @@
+2008-01-20  Matthias Clasen  <mclasen@redhat.com>
+
+       * gio/gio-sections.txt: Additions
+
 2008-01-14  Matthias Clasen  <mclasen@redhat.com>
 
        * === Released 2.15.2 ===

diff --git a/docs/reference/gio/gio-sections.txt b/docs/reference/gio/gio-sections.txt
index cd9d7698257d4a67677a382bc082f8dfcc1ce216..3f566c0543f240d86c4fb8a5a6714dba353f01fd 100644 (file)
--- a/docs/reference/gio/gio-sections.txt
+++ b/docs/reference/gio/gio-sections.txt
@@ -67,8 +67,11 @@ g_file_replace_finish
 g_file_query_info
 g_file_query_info_async
 g_file_query_info_finish
+g_file_query_exists
 g_file_query_filesystem_info
 g_file_find_enclosing_mount
+g_file_find_enclosing_mount_async
+g_file_find_enclosing_mount_finish
 g_file_enumerate_children
 g_file_enumerate_children_async
 g_file_enumerate_children_finish
@@ -349,6 +352,7 @@ g_icon_get_type
 GThemedIcon
 g_themed_icon_new
 g_themed_icon_new_from_names
+g_themed_icon_new_with_default_fallbacks
 <SUBSECTION Standard>
 GThemedIconClass
 G_THEMED_ICON
@@ -672,6 +676,7 @@ GBufferedOutputStreamPrivate
 <SECTION>
 <FILE>gmemoryoutputstream</FILE>
 <TITLE>GMemoryOutputStream</TITLE>
+GReallocFunc
 GMemoryOutputStream
 g_memory_output_stream_new
 g_memory_output_stream_get_data
@@ -1030,6 +1035,7 @@ GAppLaunchContextPrivate
 GAskPasswordFlags
 GPasswordSave
 GMountOperation
+GMountOperationResult
 g_mount_operation_new
 g_mount_operation_get_username
 g_mount_operation_set_username
@@ -1094,6 +1100,7 @@ g_unix_mount_is_system_internal
 g_unix_mount_guess_icon
 g_unix_mount_guess_name
 g_unix_mount_guess_can_eject
+g_unix_mount_guess_should_display
 g_unix_mount_point_free
 g_unix_mount_point_compare
 g_unix_mount_point_get_mount_path

diff --git a/gio/ChangeLog b/gio/ChangeLog
index f08920b342d903ad589db8aa33be074706ff018f..03c13b75a748b130923d4fc5793dffe0ce326d49 100644 (file)
--- a/gio/ChangeLog
+++ b/gio/ChangeLog
@@ -1,3 +1,12 @@
+2008-01-20  Matthias Clasen  <mclasen@redhat.com>
+
+       * gfile.c:
+       * gfilemonitor.[hc]:
+       * gmemoryinputstream.c:
+       * gmemoryoutputstream.c:
+       * gmountoperation.c:
+       * gthemedicon.c: Documentation updates
+
 2008-01-20  Murray Cumming  <murrayc@murrayc.com>
 
        * gfile.c: documentation: Fixed more minor 

diff --git a/gio/gfile.c b/gio/gfile.c
index fe89a9dbecd1761ba624f9b6c1d1b4f3bb40d425..b9d126d8999ed888dcfb7642d11e1b82709de811 100644 (file)
--- a/gio/gfile.c
+++ b/gio/gfile.c
@@ -1108,7 +1108,23 @@ g_file_find_enclosing_mount (GFile         *file,
   
   return (* iface->find_enclosing_mount) (file, cancellable, error);
 }
-
+/**
+ * g_file_find_enclosing_mount_async:
+ * @file: a #GFile
+ * @io_priority: the <link linkend="io-priority">I/O priority</link> 
+ *     of the request.
+ * @cancellable: optional #GCancellable object, %NULL to ignore.
+ * @callback: a #GAsyncReadyCallback to call when the request is satisfied
+ * @user_data: the data to pass to callback function
+ *
+ * Asynchronously gets the mount for the file.
+ *
+ * For more details, see g_file_find_enclosing_mount() which is
+ * the synchronous version of this call.
+ *
+ * When the operation is finished, @callback will be called. You can then call
+ * g_file_find_enclosing_mount_finish() to get the result of the operation.
+ */
 void
 g_file_find_enclosing_mount_async (GFile              *file,
                                   int                   io_priority,
@@ -1128,10 +1144,21 @@ g_file_find_enclosing_mount_async (GFile              *file,
                                         user_data);
 }
 
+/**
+ * g_file_find_enclosing_mount_finish:
+ * @file: a #GFile
+ * @res: a #GAsyncResult
+ * @error: a #GError
+ * 
+ * Finishes an asynchronous find mount request. 
+ * See g_file_find_enclosing_mount_async().
+ * 
+ * Returns: #GMount for given @file or %NULL on error.
+ **/
 GMount *
-g_file_find_enclosing_mount_finish (GFile              *file,
-                                   GAsyncResult         *res,
-                                   GError            **error)
+g_file_find_enclosing_mount_finish (GFile         *file,
+                                   GAsyncResult  *res,
+                                   GError       **error)
 {
   GFileIface *iface;
   

diff --git a/gio/gfilemonitor.c b/gio/gfilemonitor.c
index e481fc1e5c0e426a27627e64b575fe6617c9870b..64413918a2674969beb8b2e625ea26e470632caf 100644 (file)
--- a/gio/gfilemonitor.c
+++ b/gio/gfilemonitor.c
@@ -519,10 +519,10 @@ update_rate_limiter_timeout (GFileMonitor *monitor,
  * implementations only.
  **/
 void
-g_file_monitor_emit_event (GFileMonitor *monitor,
-                          GFile *child,
-                          GFile *other_file,
-                          GFileMonitorEvent event_type)
+g_file_monitor_emit_event (GFileMonitor      *monitor,
+                          GFile             *child,
+                          GFile             *other_file,
+                          GFileMonitorEvent  event_type)
 {
   guint32 time_now, since_last;
   gboolean emit_now;

diff --git a/gio/gfilemonitor.h b/gio/gfilemonitor.h
index 22cd937873df814a226f854693f3fc1aa7689d5a..dfc3e26d7aad07b67a0ec69d85d5d590c07450d5 100644 (file)
--- a/gio/gfilemonitor.h
+++ b/gio/gfilemonitor.h
@@ -109,7 +109,7 @@ void     g_file_monitor_set_rate_limit (GFileMonitor *monitor,
 
 /* For implementations */
 void g_file_monitor_emit_event (GFileMonitor      *monitor,
-                               GFile             *file,
+                               GFile             *child,
                                GFile             *other_file,
                                GFileMonitorEvent  event_type);
 

diff --git a/gio/gmemoryinputstream.c b/gio/gmemoryinputstream.c
index 9255efbf67a1c84886d9fc61d57f192630d9a1cf..69dbb884ca1f3b00b95dd4a1015d22a40c1b69e2 100644 (file)
--- a/gio/gmemoryinputstream.c
+++ b/gio/gmemoryinputstream.c
@@ -185,6 +185,13 @@ g_memory_input_stream_init (GMemoryInputStream *stream)
                                               GMemoryInputStreamPrivate);
 }
 
+/**
+ * g_memory_input_stream_new:
+ *
+ * Creates a new empty #GMemoryInputStream. 
+ *
+ * Returns: a new #GInputStream
+ */
 GInputStream *
 g_memory_input_stream_new (void)
 {
@@ -220,6 +227,15 @@ g_memory_input_stream_new_from_data (const void     *data,
   return stream;
 }
 
+/**
+ * g_memory_input_stream_add_data:
+ * @stream: a #GMemoryInputStream
+ * @data: input data
+ * @len: length of the data, may be -1 if @data is a nul-terminated string
+ * @destroy: function that is called to free @data, or %NULL
+ *
+ * Appends @data to data that can be read from the input stream
+ */
 void
 g_memory_input_stream_add_data (GMemoryInputStream *stream,
                                 const void         *data,

diff --git a/gio/gmemoryoutputstream.h b/gio/gmemoryoutputstream.h
index 612ea1fd29ccedf5f4b4f330b8290ca95f41336b..99fd8c2ec21fd9c60676cf3d0439464f30478433 100644 (file)
--- a/gio/gmemoryoutputstream.h
+++ b/gio/gmemoryoutputstream.h
@@ -69,6 +69,18 @@ struct _GMemoryOutputStreamClass
   void (*_g_reserved5) (void);
 };
 
+/**
+ * GReallocFunc:
+ * @data: memory block to reallocate
+ * @size: size to reallocate @data to
+ *
+ * Changes the size of the memory block pointed to by @data to
+ * @size bytes. 
+ *
+ * The function should have the same semantics as realloc().
+ *
+ * Returns: a pointer to the reallocated memory
+ */
 typedef gpointer (*GReallocFunc) (gpointer data, gsize size);
 
 GType          g_memory_output_stream_get_type (void) G_GNUC_CONST;

diff --git a/gio/gmountoperation.c b/gio/gmountoperation.c
index c810eb7b298609b7136d773eb88de1df4b3f291a..ead314d27c339319cd28901badc8c5f6a53d92d1 100644 (file)
--- a/gio/gmountoperation.c
+++ b/gio/gmountoperation.c
@@ -620,8 +620,8 @@ g_mount_operation_set_choice (GMountOperation *op,
 
 /**
  * g_mount_operation_reply:
- * @op: a #GMountOperation.
- * @abort: boolean.
+ * @op: a #GMountOperation
+ * @result: a #GMountOperationResult
  * 
  * Emits the #GMountOperation::reply signal.
  **/

diff --git a/gio/gthemedicon.c b/gio/gthemedicon.c
index fdfbd4347a5af6b3c0ed173133f1dfcc4cfc5abc..a7dc92bdfb9b11b7a32291f8b47fa2013e7d3421 100644 (file)
--- a/gio/gthemedicon.c
+++ b/gio/gthemedicon.c
@@ -143,6 +143,28 @@ g_themed_icon_new_from_names (char **iconnames,
   return G_ICON (themed);
 }
 
+/**
+ * g_themed_icon_new_with_default_fallbacks:
+ * @iconname: a string containing an icon name
+ *
+ * Creates a new themed icon for @iconname, and all the names
+ * that can be created by shortening @iconname at '-' characters.
+ * 
+ * In the following example, @icon1 and @icon2 are equivalent:
+ * |[
+ * const char *names[] = { 
+ *   "gnome-dev-cdrom-audio",
+ *   "gnome-dev-cdrom",
+ *   "gnome-dev",
+ *   "gnome"
+ * };
+ *
+ * icon1 = g_themed_icon_new_from_names (names, 4);
+ * icon2 = g_themed_icon_new_with_default_fallbacks ("gnome-dev-cdrom-audio");
+ * ]|
+ *
+ * Returns: a new #GThemedIcon.
+ */
 GIcon *
 g_themed_icon_new_with_default_fallbacks (const char *iconname)
 {