Move documentation to inline comments: GtkMountOperation

https://bugzilla.gnome.org/show_bug.cgi?id=597865

diff --git a/docs/reference/gtk/tmpl/filesystem.sgml b/docs/reference/gtk/tmpl/filesystem.sgml
deleted file mode 100644 (file)
index 0558cd2..0000000
--- a/docs/reference/gtk/tmpl/filesystem.sgml
+++ /dev/null
@@ -1,106 +0,0 @@
-<!-- ##### SECTION Title ##### -->
-Filesystem utilities
-
-<!-- ##### SECTION Short_Description ##### -->
-
-
-<!-- ##### SECTION Long_Description ##### -->
-<para>
-
-</para>
-
-<!-- ##### SECTION See_Also ##### -->
-<para>
-
-</para>
-
-<!-- ##### SECTION Stability_Level ##### -->
-
-
-<!-- ##### STRUCT GtkMountOperation ##### -->
-<para>
-
-</para>
-
-
-<!-- ##### ARG GtkMountOperation:is-showing ##### -->
-<para>
-
-</para>
-
-<!-- ##### ARG GtkMountOperation:parent ##### -->
-<para>
-
-</para>
-
-<!-- ##### ARG GtkMountOperation:screen ##### -->
-<para>
-
-</para>
-
-<!-- ##### FUNCTION gtk_mount_operation_new ##### -->
-<para>
-
-</para>
-
-@parent: 
-@Returns: 
-
-
-<!-- ##### FUNCTION gtk_mount_operation_is_showing ##### -->
-<para>
-
-</para>
-
-@op: 
-@Returns: 
-
-
-<!-- ##### FUNCTION gtk_mount_operation_set_parent ##### -->
-<para>
-
-</para>
-
-@op: 
-@parent: 
-
-
-<!-- ##### FUNCTION gtk_mount_operation_get_parent ##### -->
-<para>
-
-</para>
-
-@op: 
-@Returns: 
-
-
-<!-- ##### FUNCTION gtk_mount_operation_set_screen ##### -->
-<para>
-
-</para>
-
-@op: 
-@screen: 
-
-
-<!-- ##### FUNCTION gtk_mount_operation_get_screen ##### -->
-<para>
-
-</para>
-
-@op: 
-@Returns: 
-
-
-<!-- ##### FUNCTION gtk_show_uri ##### -->
-<para>
-
-</para>
-
-@screen: 
-@uri: 
-@timestamp: 
-@error: 
-@Returns: 
-
-

diff --git a/gtk/gtkmountoperation.c b/gtk/gtkmountoperation.c
index 4a1c9f8a8b2c5ef74a0e54e5af781a7fd3e20c18..eff119067c8ddeda49101b2ede9b07a4084cd533 100644 (file)
--- 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 f006082dabb1b522b2cd4e16e78f480110c3553b..db6e51bba8fc2dd4432b7e5c62777fbb436f25fe 100644 (file)
--- 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;