[gtk/matthiasc/for-master: 51/51] droptarget: Some docs cleanups




commit 441d944c081d66fd9b745f1050e9d20976f71829
Author: Matthias Clasen <mclasen redhat com>
Date:   Fri Jan 8 22:20:04 2021 -0500

    droptarget: Some docs cleanups
    
    Fixes #3565, among other things.

 gtk/gtkdroptarget.c | 24 +++++++++++-------------
 1 file changed, 11 insertions(+), 13 deletions(-)
---
diff --git a/gtk/gtkdroptarget.c b/gtk/gtkdroptarget.c
index 55ed341d00..3e2a3a8103 100644
--- a/gtk/gtkdroptarget.c
+++ b/gtk/gtkdroptarget.c
@@ -47,7 +47,7 @@
  * The most basic way to use a #GtkDropTarget to receive drops on a
  * widget is to create it via gtk_drop_target_new() passing in the
  * #GType of the data you want to receive and connect to the
- * GtkDropTarget::drop signal to receive the data:
+ * #GtkDropTarget::drop signal to receive the data:
  *
  * |[<!-- language="C" -->
  * static gboolean
@@ -677,9 +677,9 @@ gtk_drop_target_class_init (GtkDropTargetClass *class)
    * The value for this drop operation or %NULL if the data has not been
    * loaded yet or no drop operation is going on.
    *
-   * Data may be available before the GtkDropTarget::drop signal gets emitted -
-   * for example when the GtkDropTarget:preload property is set.
-   * You can use the GObject::notify signal to be notified of available data.
+   * Data may be available before the #GtkDropTarget::drop signal gets emitted -
+   * for example when the #GtkDropTarget:preload property is set.
+   * You can use the #GObject::notify signal to be notified of available data.
    */
   properties[PROP_VALUE] =
        g_param_spec_boxed ("value",
@@ -696,20 +696,20 @@ gtk_drop_target_class_init (GtkDropTargetClass *class)
    * @drop: the #GdkDrop
    *
    * The ::accept signal is emitted on the drop site when a drop operation
-   * is about to begin.  
+   * is about to begin.
    * If the drop is not accepted, %FALSE will be returned and the drop target
    * will ignore the drop. If %TRUE is returned, the drop is accepted for now
    * but may be rejected later via a call to gtk_drop_target_reject() or
-   * ultimately by returning %FALSE from GtkDropTarget::drop
+   * ultimately by returning %FALSE from #GtkDropTarget::drop.
    *
    * The default handler for this signal decides whether to accept the drop
    * based on the formats provided by the @drop.
    *
-   * If the decision whether the drop will be accepted or rejected needs
-   * inspecting the data, this function should return %TRUE, the 
-   * GtkDropTarget:preload property should be set and the value
-   * should be inspected via the GObject::notify:value signal and then call
-   * gtk_drop_target_reject().
+   * If the decision whether the drop will be accepted or rejected depends
+   * on the data, this function should return %TRUE, the #GtkDropTarget:preload
+   * property should be set and the value should be inspected via the
+   * #GObject::notify:value signal, calling gtk_drop_target_reject() if
+   * required.
    *
    * Returns: %TRUE if @drop is accepted
    */
@@ -874,8 +874,6 @@ gtk_drop_target_get_formats (GtkDropTarget *self)
  * @n_types: number of @types
  *
  * Sets the supported #GTypes for this drop target.
- *
- * The GtkDropTarget::drop signal will 
  **/
 void
 gtk_drop_target_set_gtypes (GtkDropTarget *self,


[Date Prev][Date Next]   [Thread Prev][Thread Next]   [Thread Index] [Date Index] [Author Index]