More doc fixes
authorMatthias Clasen <matthiasc@src.gnome.org>
Mon, 21 Jul 2008 02:46:54 +0000 (02:46 +0000)
committerMatthias Clasen <matthiasc@src.gnome.org>
Mon, 21 Jul 2008 02:46:54 +0000 (02:46 +0000)
svn path=/trunk/; revision=7225

gio/ChangeLog
gio/gioenums.h
gio/gmountoperation.c
gio/gvolumemonitor.c
gio/gvolumemonitor.h

index 580f710672ae2040dcacd8b04433327d560ebe56..3e273a77946122909d5ca8aef84d2c6ae227e05b 100644 (file)
@@ -1,5 +1,8 @@
 2008-07-20  Matthias Clasen  <mclasen@redhat.com>
 
+       * gvolumemonitor.[hc]:
+       * gmountoperation.c:
+       * gioenums.h:
        * gdrive.c:
        * gvfs.c:
        * gmount.c: Documentation fixes
index cab54a7d10906301fb92d8d4754d9db889b19d39..525bc6c4df0e8ab8943bca647b7be2b7d895cd16 100644 (file)
@@ -377,7 +377,6 @@ typedef enum {
  * #GAskPasswordFlags are used to request specific information from the
  * user, or to notify the user of their choices in an authentication
  * situation.
- *
  **/
 typedef enum {
   G_ASK_PASSWORD_NEED_PASSWORD       = (1 << 0),
@@ -408,12 +407,15 @@ typedef enum {
 
 /**
  * GMountOperationResult:
- * @G_MOUNT_OPERATION_HANDLED: The request was fulfilled and the user specified data is now availible
- * @G_MOUNT_OPERATION_ABORTED: The user requested the mount operation to be aborted
- * @G_MOUNT_OPERATION_UNHANDLED: The request was unhandled (i.e. not implemented)
+ * @G_MOUNT_OPERATION_HANDLED: The request was fulfilled and the 
+ *     user specified data is now available
+ * @G_MOUNT_OPERATION_ABORTED: The user requested the mount operation 
+ *     to be aborted
+ * @G_MOUNT_OPERATION_UNHANDLED: The request was unhandled (i.e. not 
+ *     implemented)
  * 
- * #GMountOperationResult is returned as a result when a request for information
- * is send by the mounting operation.
+ * #GMountOperationResult is returned as a result when a request for 
+ * information is send by the mounting operation.
  **/
 typedef enum {
   G_MOUNT_OPERATION_HANDLED,
@@ -425,8 +427,10 @@ typedef enum {
 /**
  * GOutputStreamSpliceFlags:
  * @G_OUTPUT_STREAM_SPLICE_NONE: Do not close either stream.
- * @G_OUTPUT_STREAM_SPLICE_CLOSE_SOURCE: Close the source stream after the splice.
- * @G_OUTPUT_STREAM_SPLICE_CLOSE_TARGET: Close the target stream after the splice.
+ * @G_OUTPUT_STREAM_SPLICE_CLOSE_SOURCE: Close the source stream after 
+ *     the splice.
+ * @G_OUTPUT_STREAM_SPLICE_CLOSE_TARGET: Close the target stream after 
+ *     the splice.
  *
  * GOutputStreamSpliceFlags determine how streams should be spliced.
  **/
index d4b02bc8c3f6cfa9111ebe3382d166844c75893f..96f360c67a6eea2caace948c8fd85026530b2f07 100644 (file)
@@ -282,7 +282,7 @@ g_mount_operation_class_init (GMountOperationClass *klass)
   /**
    * GMountOperation::reply:
    * @op: a #GMountOperation.
-   * @abort: a boolean indicating %TRUE if the operation was aborted.
+   * @result: a #GMountOperationResult indicating how the request was handled
    * 
    * Emitted when the user has replied to the mount operation.
    */
@@ -427,7 +427,6 @@ g_mount_operation_get_username (GMountOperation *op)
  * @username: input username.
  *
  * Sets the user name within @op to @username.
- * 
  **/
 void
 g_mount_operation_set_username (GMountOperation *op,
index 4c3aeea2195cbbcd9c6acda767e7402622b0b3d8..2e1944311b988f85cdab2fa2057308088156d315 100644 (file)
@@ -264,7 +264,7 @@ g_volume_monitor_init (GVolumeMonitor *monitor)
  * The returned list should be freed with g_list_free(), after
  * its elements have been unreffed with g_object_unref().
  *
- * Returns: a #GList of connected #GDrive<!-- -->s
+ * Returns: a #GList of connected #GDrive objects.
  **/
 GList *
 g_volume_monitor_get_connected_drives (GVolumeMonitor *volume_monitor)
@@ -287,7 +287,7 @@ g_volume_monitor_get_connected_drives (GVolumeMonitor *volume_monitor)
  * The returned list should be freed with g_list_free(), after
  * its elements have been unreffed with g_object_unref().
  *
- * Returns: a #GList of #GVolume<!-- -->s.
+ * Returns: a #GList of #GVolume objects.
  **/
 GList *
 g_volume_monitor_get_volumes (GVolumeMonitor *volume_monitor)
@@ -310,7 +310,7 @@ g_volume_monitor_get_volumes (GVolumeMonitor *volume_monitor)
  * The returned list should be freed with g_list_free(), after
  * its elements have been unreffed with g_object_unref().
  * 
- * Returns: a #GList of #GMount<!-- -->s
+ * Returns: a #GList of #GMount objects.
  **/
 GList *
 g_volume_monitor_get_mounts (GVolumeMonitor *volume_monitor)
index 3376378e654e0cccbbe39e5c814951b7136d8a5b..6ef68e9b2ec2bfbba8c039e19607ccc88815d655 100644 (file)
@@ -45,7 +45,7 @@ G_BEGIN_DECLS
  * G_VOLUME_MONITOR_EXTENSION_POINT_NAME:
  *
  * Extension point for volume monitor functionality.
- * See <link linkend="gio-extension-points">Extending GIO</link>.
+ * See <link linkend="extending-gio">Extending GIO</link>.
  */
 #define G_VOLUME_MONITOR_EXTENSION_POINT_NAME "gio-volume-monitor"