[gtk/ebassi/gidocgen: 462/481] mountoperation: Convert docs
- From: Emmanuele Bassi <ebassi src gnome org>
- To: commits-list gnome org
- Cc:
- Subject: [gtk/ebassi/gidocgen: 462/481] mountoperation: Convert docs
- Date: Sun, 7 Mar 2021 23:55:17 +0000 (UTC)
commit 7bc79a3fb93905092aee4dcaf980a761f1fa703a
Author: Matthias Clasen <mclasen redhat com>
Date: Mon Mar 1 22:52:20 2021 -0500
mountoperation: Convert docs
gtk/gtkmountoperation.c | 73 ++++++++++++++++++++++++++-----------------------
gtk/gtkmountoperation.h | 5 ----
2 files changed, 39 insertions(+), 39 deletions(-)
---
diff --git a/gtk/gtkmountoperation.c b/gtk/gtkmountoperation.c
index c7b36081f0..0eb1379e97 100644
--- a/gtk/gtkmountoperation.c
+++ b/gtk/gtkmountoperation.c
@@ -63,31 +63,21 @@
#include <glib/gprintf.h>
/**
- * SECTION:gtkmountoperation
- * @short_description: Functions for working with GIO
- * @Title: Filesystem utilities
+ * GtkMountOperation:
*
- * `GtkMountOperation` is an implementation of `GMountOperation` that
- * can use a graphical user interface when requiring information from
- * the user, like passwords or other information.
+ * `GtkMountOperation` is an implementation of `GMountOperation`.
*
* The functions and objects described here make working with GTK and
* GIO more convenient.
*
- * #GtkMountOperation is needed when mounting volumes:
- * It is an implementation of #GMountOperation that can be used with
+ * `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_with_operation() and others.
*
- * When necessary, #GtkMountOperation shows dialogs to ask for
- * passwords, questions or show processes blocking unmount.
- *
- * gtk_show_uri_on_window() 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 launching
- * applications.
+ * When necessary, `GtkMountOperation` shows dialogs to let the user
+ * enter passwords, ask questions or show processes blocking unmount.
*/
static void gtk_mount_operation_finalize (GObject *object);
@@ -172,6 +162,11 @@ gtk_mount_operation_class_init (GtkMountOperationClass *klass)
mount_op_class->show_processes = gtk_mount_operation_show_processes;
mount_op_class->aborted = gtk_mount_operation_aborted;
+ /**
+ * GtkMountOperation:parent: (attributes org.gtk.Property.get=gtk_mount_operation_get_parent
org.gtk.Property.set=gtk_mount_operation_set_parent)
+ *
+ * The parent window.
+ */
g_object_class_install_property (object_class,
PROP_PARENT,
g_param_spec_object ("parent",
@@ -180,6 +175,11 @@ gtk_mount_operation_class_init (GtkMountOperationClass *klass)
GTK_TYPE_WINDOW,
GTK_PARAM_READWRITE));
+ /**
+ * GtkMountOperation:is-showing: (attributes org.gtk.Property.get=gtk_mount_operation_is_showing)
+ *
+ * Whether a dialog is currently shown.
+ */
g_object_class_install_property (object_class,
PROP_IS_SHOWING,
g_param_spec_boolean ("is-showing",
@@ -188,6 +188,11 @@ gtk_mount_operation_class_init (GtkMountOperationClass *klass)
FALSE,
GTK_PARAM_READABLE));
+ /**
+ * GtkMountOperation:display: (attributes org.gtk.Property.get=gtk_mount_operation_get_display
org.gtk.Property.set=gtk_mount_operation_set_display)
+ *
+ * The display where dialogs will be shown.
+ */
g_object_class_install_property (object_class,
PROP_DISPLAY,
g_param_spec_object ("display",
@@ -1790,9 +1795,9 @@ gtk_mount_operation_aborted (GMountOperation *op)
* gtk_mount_operation_new:
* @parent: (allow-none): transient parent of the window, or %NULL
*
- * Creates a new #GtkMountOperation
+ * Creates a new `GtkMountOperation`.
*
- * Returns: a new #GtkMountOperation
+ * Returns: a new `GtkMountOperation`
*/
GMountOperation *
gtk_mount_operation_new (GtkWindow *parent)
@@ -1806,10 +1811,10 @@ gtk_mount_operation_new (GtkWindow *parent)
}
/**
- * gtk_mount_operation_is_showing:
- * @op: a #GtkMountOperation
+ * gtk_mount_operation_is_showing: (attributes org.gtk.Method.get_property=is-showing)
+ * @op: a `GtkMountOperation`
*
- * Returns whether the #GtkMountOperation is currently displaying
+ * Returns whether the `GtkMountOperation` is currently displaying
* a window.
*
* Returns: %TRUE if @op is currently displaying a window
@@ -1823,12 +1828,12 @@ gtk_mount_operation_is_showing (GtkMountOperation *op)
}
/**
- * gtk_mount_operation_set_parent:
- * @op: a #GtkMountOperation
+ * gtk_mount_operation_set_parent: (attributes org.gtk.Method.set_property=parent)
+ * @op: a `GtkMountOperation`
* @parent: (allow-none): transient parent of the window, or %NULL
*
* Sets the transient parent for windows shown by the
- * #GtkMountOperation.
+ * `GtkMountOperation`.
*/
void
gtk_mount_operation_set_parent (GtkMountOperation *op,
@@ -1866,10 +1871,10 @@ gtk_mount_operation_set_parent (GtkMountOperation *op,
}
/**
- * gtk_mount_operation_get_parent:
- * @op: a #GtkMountOperation
+ * gtk_mount_operation_get_parent: (attributes org.gtk.Method.get_property=parent)
+ * @op: a `GtkMountOperation`
*
- * Gets the transient parent used by the #GtkMountOperation
+ * Gets the transient parent used by the `GtkMountOperation`.
*
* Returns: (transfer none): the transient parent for windows shown by @op
*/
@@ -1882,11 +1887,11 @@ gtk_mount_operation_get_parent (GtkMountOperation *op)
}
/**
- * gtk_mount_operation_set_display:
- * @op: a #GtkMountOperation
- * @display: a #GdkDisplay
+ * gtk_mount_operation_set_display: (attributes org.gtk.Method.set_property=display)
+ * @op: a `GtkMountOperation`
+ * @display: a `GdkDisplay`
*
- * Sets the display to show windows of the #GtkMountOperation on.
+ * Sets the display to show windows of the `GtkMountOperation` on.
*/
void
gtk_mount_operation_set_display (GtkMountOperation *op,
@@ -1914,10 +1919,10 @@ gtk_mount_operation_set_display (GtkMountOperation *op,
}
/**
- * gtk_mount_operation_get_display:
- * @op: a #GtkMountOperation
+ * gtk_mount_operation_get_display: (attributes org.gtk.Method.get_property=display)
+ * @op: a `GtkMountOperation`
*
- * Gets the display on which windows of the #GtkMountOperation
+ * Gets the display on which windows of the `GtkMountOperation`
* will be shown.
*
* Returns: (transfer none): the display on which windows of @op are shown
diff --git a/gtk/gtkmountoperation.h b/gtk/gtkmountoperation.h
index 3bb1787884..7eb7bd4675 100644
--- a/gtk/gtkmountoperation.h
+++ b/gtk/gtkmountoperation.h
@@ -42,11 +42,6 @@ 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;
[
Date Prev][
Date Next] [
Thread Prev][
Thread Next]
[
Thread Index]
[
Date Index]
[
Author Index]