More doc fixes

svn path=/trunk/; revision=7225
This commit is contained in:
Matthias Clasen
2008-07-21 02:46:54 +00:00
parent c0aacc7c4c
commit d420020715
5 changed files with 20 additions and 14 deletions

View File

@@ -1,5 +1,8 @@
2008-07-20 Matthias Clasen <mclasen@redhat.com> 2008-07-20 Matthias Clasen <mclasen@redhat.com>
* gvolumemonitor.[hc]:
* gmountoperation.c:
* gioenums.h:
* gdrive.c: * gdrive.c:
* gvfs.c: * gvfs.c:
* gmount.c: Documentation fixes * gmount.c: Documentation fixes

View File

@@ -377,7 +377,6 @@ typedef enum {
* #GAskPasswordFlags are used to request specific information from the * #GAskPasswordFlags are used to request specific information from the
* user, or to notify the user of their choices in an authentication * user, or to notify the user of their choices in an authentication
* situation. * situation.
*
**/ **/
typedef enum { typedef enum {
G_ASK_PASSWORD_NEED_PASSWORD = (1 << 0), G_ASK_PASSWORD_NEED_PASSWORD = (1 << 0),
@@ -408,12 +407,15 @@ typedef enum {
/** /**
* GMountOperationResult: * GMountOperationResult:
* @G_MOUNT_OPERATION_HANDLED: The request was fulfilled and the user specified data is now availible * @G_MOUNT_OPERATION_HANDLED: The request was fulfilled and the
* @G_MOUNT_OPERATION_ABORTED: The user requested the mount operation to be aborted * user specified data is now available
* @G_MOUNT_OPERATION_UNHANDLED: The request was unhandled (i.e. not implemented) * @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 * #GMountOperationResult is returned as a result when a request for
* is send by the mounting operation. * information is send by the mounting operation.
**/ **/
typedef enum { typedef enum {
G_MOUNT_OPERATION_HANDLED, G_MOUNT_OPERATION_HANDLED,
@@ -425,8 +427,10 @@ typedef enum {
/** /**
* GOutputStreamSpliceFlags: * GOutputStreamSpliceFlags:
* @G_OUTPUT_STREAM_SPLICE_NONE: Do not close either stream. * @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_SOURCE: Close the source stream after
* @G_OUTPUT_STREAM_SPLICE_CLOSE_TARGET: Close the target stream after the splice. * the splice.
* @G_OUTPUT_STREAM_SPLICE_CLOSE_TARGET: Close the target stream after
* the splice.
* *
* GOutputStreamSpliceFlags determine how streams should be spliced. * GOutputStreamSpliceFlags determine how streams should be spliced.
**/ **/

View File

@@ -282,7 +282,7 @@ g_mount_operation_class_init (GMountOperationClass *klass)
/** /**
* GMountOperation::reply: * GMountOperation::reply:
* @op: a #GMountOperation. * @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. * Emitted when the user has replied to the mount operation.
*/ */
@@ -427,7 +427,6 @@ g_mount_operation_get_username (GMountOperation *op)
* @username: input username. * @username: input username.
* *
* Sets the user name within @op to @username. * Sets the user name within @op to @username.
*
**/ **/
void void
g_mount_operation_set_username (GMountOperation *op, g_mount_operation_set_username (GMountOperation *op,

View File

@@ -264,7 +264,7 @@ g_volume_monitor_init (GVolumeMonitor *monitor)
* The returned list should be freed with g_list_free(), after * The returned list should be freed with g_list_free(), after
* its elements have been unreffed with g_object_unref(). * its elements have been unreffed with g_object_unref().
* *
* Returns: a #GList of connected #GDrive<!-- -->s * Returns: a #GList of connected #GDrive objects.
**/ **/
GList * GList *
g_volume_monitor_get_connected_drives (GVolumeMonitor *volume_monitor) 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 * The returned list should be freed with g_list_free(), after
* its elements have been unreffed with g_object_unref(). * its elements have been unreffed with g_object_unref().
* *
* Returns: a #GList of #GVolume<!-- -->s. * Returns: a #GList of #GVolume objects.
**/ **/
GList * GList *
g_volume_monitor_get_volumes (GVolumeMonitor *volume_monitor) 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 * The returned list should be freed with g_list_free(), after
* its elements have been unreffed with g_object_unref(). * its elements have been unreffed with g_object_unref().
* *
* Returns: a #GList of #GMount<!-- -->s * Returns: a #GList of #GMount objects.
**/ **/
GList * GList *
g_volume_monitor_get_mounts (GVolumeMonitor *volume_monitor) g_volume_monitor_get_mounts (GVolumeMonitor *volume_monitor)

View File

@@ -45,7 +45,7 @@ G_BEGIN_DECLS
* G_VOLUME_MONITOR_EXTENSION_POINT_NAME: * G_VOLUME_MONITOR_EXTENSION_POINT_NAME:
* *
* Extension point for volume monitor functionality. * 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" #define G_VOLUME_MONITOR_EXTENSION_POINT_NAME "gio-volume-monitor"