From 25e3329215a11190a4846dada95d8fd305ac74f8 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Javier=20Jard=C3=B3n?= Date: Wed, 14 Oct 2009 23:44:59 +0200 Subject: [PATCH] Move documentation to inline comments: GtkMountOperation https://bugzilla.gnome.org/show_bug.cgi?id=597865 --- docs/reference/gtk/tmpl/filesystem.sgml | 106 ------------------------ gtk/gtkmountoperation.c | 24 +++--- gtk/gtkmountoperation.h | 5 ++ 3 files changed, 17 insertions(+), 118 deletions(-) delete mode 100644 docs/reference/gtk/tmpl/filesystem.sgml diff --git a/docs/reference/gtk/tmpl/filesystem.sgml b/docs/reference/gtk/tmpl/filesystem.sgml deleted file mode 100644 index 0558cd2b10..0000000000 --- a/docs/reference/gtk/tmpl/filesystem.sgml +++ /dev/null @@ -1,106 +0,0 @@ - -Filesystem utilities - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -@parent: -@Returns: - - - - - - - -@op: -@Returns: - - - - - - - -@op: -@parent: - - - - - - - -@op: -@Returns: - - - - - - - -@op: -@screen: - - - - - - - -@op: -@Returns: - - - - - - - -@screen: -@uri: -@timestamp: -@error: -@Returns: - - diff --git a/gtk/gtkmountoperation.c b/gtk/gtkmountoperation.c index 4a1c9f8a8b..eff119067c 100644 --- a/gtk/gtkmountoperation.c +++ b/gtk/gtkmountoperation.c @@ -58,25 +58,25 @@ /** * SECTION:filesystem * @short_description: Functions for working with GIO + * @Title: Filesystem utilities * * The functions and objects described here make working with GTK+ and - * GIO more convenient. #GtkMountOperation is needed when mounting volumes - * and gtk_show_uri() is a convenient way to launch applications for URIs. - * Another object that is worth mentioning in this context is - * #GdkAppLaunchContext, which provides visual feedback when lauching - * applications. - */ - -/** - * GtkMountOperation: + * GIO more convenient. * - * #GtkMountOperation is an implementation of #GMountOperation that - * can be used with GIO functions for mounting volumes such as + * #GtkMountOperation is needed when mounting volumes: + * It is an implementation of #GMountOperation that can be used with + * GIO functions for mounting volumes such as * g_file_mount_enclosing_volume(), g_file_mount_mountable(), - * g_volume_mount(), g_mount_unmount() and others. + * g_volume_mount(), g_mount_unmount_with_operation() and others. * * When necessary, #GtkMountOperation shows dialogs to ask for * passwords, questions or show processes blocking unmount. + * + * gtk_show_uri() is a convenient way to launch applications for URIs. + * + * Another object that is worth mentioning in this context is + * #GdkAppLaunchContext, which provides visual feedback when lauching + * applications. */ static void gtk_mount_operation_finalize (GObject *object); diff --git a/gtk/gtkmountoperation.h b/gtk/gtkmountoperation.h index f006082dab..db6e51bba8 100644 --- a/gtk/gtkmountoperation.h +++ b/gtk/gtkmountoperation.h @@ -44,6 +44,11 @@ typedef struct _GtkMountOperation GtkMountOperation; typedef struct _GtkMountOperationClass GtkMountOperationClass; typedef struct _GtkMountOperationPrivate GtkMountOperationPrivate; +/** + * GtkMountOperation: + * + * This should not be accessed directly. Use the accessor functions below. + */ struct _GtkMountOperation { GMountOperation parent_instance;