[gtk+/wip/baedert/drawing: 343/355] Fix a few documentation issues



commit 5de2691337190648ab936e27e10ebd34f7f73ce2
Author: Timm Bäder <mail baedert org>
Date:   Sat Jul 8 09:56:41 2017 +0200

    Fix a few documentation issues

 gtk/gtkbuilder.c           |    4 ----
 gtk/gtkcolorbutton.c       |    4 ++--
 gtk/gtkdrawingarea.c       |    3 +--
 gtk/gtkeventcontroller.c   |    2 +-
 gtk/gtkfilechooserdialog.c |    2 +-
 gtk/gtkfilechoosernative.c |    8 ++++----
 gtk/gtkmain.c              |    1 +
 gtk/gtkorientable.c        |    4 +---
 8 files changed, 11 insertions(+), 17 deletions(-)
---
diff --git a/gtk/gtkbuilder.c b/gtk/gtkbuilder.c
index 4c03243..eda1555 100644
--- a/gtk/gtkbuilder.c
+++ b/gtk/gtkbuilder.c
@@ -62,10 +62,6 @@
  * specified in an XML format which can be roughly described by the
  * RELAX NG schema below. We refer to these descriptions as “GtkBuilder
  * UI definitions” or just “UI definitions” if the context is clear.
- * Do not confuse GtkBuilder UI Definitions with
- * [GtkUIManager UI Definitions][XML-UI], which are more limited in scope.
- * It is common to use `.ui` as the filename extension for files containing
- * GtkBuilder UI definitions.
  *
  * [RELAX NG Compact Syntax](https://git.gnome.org/browse/gtk+/tree/gtk/gtkbuilder.rnc)
  *
diff --git a/gtk/gtkcolorbutton.c b/gtk/gtkcolorbutton.c
index 2d63e8d..bfe716b 100644
--- a/gtk/gtkcolorbutton.c
+++ b/gtk/gtkcolorbutton.c
@@ -48,7 +48,7 @@
  * SECTION:gtkcolorbutton
  * @Short_description: A button to launch a color selection dialog
  * @Title: GtkColorButton
- * @See_also: #GtkColorSelectionDialog, #GtkFontButton
+ * @See_also: #GtkFontButton
  *
  * The #GtkColorButton is a button which displays the currently selected
  * color and allows to open a color selection dialog to change the color.
@@ -251,7 +251,7 @@ gtk_color_button_class_init (GtkColorButtonClass *klass)
    * @widget: the object which received the signal.
    *
    * The ::color-set signal is emitted when the user selects a color.
-   * When handling this signal, use gtk_color_button_get_rgba() to
+   * When handling this signal, use gtk_color_chooser_get_rgba() to
    * find out which color was just selected.
    *
    * Note that this signal is only emitted when the user
diff --git a/gtk/gtkdrawingarea.c b/gtk/gtkdrawingarea.c
index 12d46e7..c36c983 100644
--- a/gtk/gtkdrawingarea.c
+++ b/gtk/gtkdrawingarea.c
@@ -61,8 +61,7 @@ static GParamSpec *props[LAST_PROP] = { NULL, };
  * creating a drawing area, the application may want to connect to:
  *
  * - Mouse and button press signals to respond to input from
- *   the user. (Use gtk_widget_add_events() to enable events
- *   you wish to receive.)
+ *   the user.
  *
  * - The #GtkWidget::realize signal to take any necessary actions
  *   when the widget is instantiated on a particular display.
diff --git a/gtk/gtkeventcontroller.c b/gtk/gtkeventcontroller.c
index 28a3689..4a98c44 100644
--- a/gtk/gtkeventcontroller.c
+++ b/gtk/gtkeventcontroller.c
@@ -289,7 +289,7 @@ gtk_event_controller_get_widget (GtkEventController *controller)
  * @controller: a #GtkEventController
  *
  * Resets the @controller to a clean state. Every interaction
- * the controller did through #GtkEventController::handle-event
+ * the controller did through gtk_event_controll_handle_event()
  * will be dropped at this point.
  *
  * Since: 3.14
diff --git a/gtk/gtkfilechooserdialog.c b/gtk/gtkfilechooserdialog.c
index 93bdd03..833738e 100644
--- a/gtk/gtkfilechooserdialog.c
+++ b/gtk/gtkfilechooserdialog.c
@@ -45,7 +45,7 @@
  * SECTION:gtkfilechooserdialog
  * @Short_description: A file chooser dialog, suitable for “File/Open” or “File/Save” commands
  * @Title: GtkFileChooserDialog
- * @See_also: #GtkFileChooser, #GtkDialog, GtkFileChooserNative
+ * @See_also: #GtkFileChooser, #GtkDialog, #GtkFileChooserNative
  *
  * #GtkFileChooserDialog is a dialog box suitable for use with
  * “File/Open” or “File/Save as” commands.  This widget works by
diff --git a/gtk/gtkfilechoosernative.c b/gtk/gtkfilechoosernative.c
index a6a75f8..3cca631 100644
--- a/gtk/gtkfilechoosernative.c
+++ b/gtk/gtkfilechoosernative.c
@@ -213,7 +213,7 @@ G_DEFINE_TYPE_WITH_CODE (GtkFileChooserNative, gtk_file_chooser_native, GTK_TYPE
 
 /**
  * gtk_file_chooser_native_get_accept_label:
- * @self: a #GtFileChooserNative
+ * @self: a #GtkFileChooserNative
  *
  * Retrieves the custom label text for the accept button.
  *
@@ -232,7 +232,7 @@ gtk_file_chooser_native_get_accept_label (GtkFileChooserNative *self)
 
 /**
  * gtk_file_chooser_native_set_accept_label:
- * @self: a #GtFileChooserNative
+ * @self: a #GtkFileChooserNative
  * @accept_label: (allow-none): custom label or %NULL for the default
  *
  * Sets the custom label text for the accept button.
@@ -259,7 +259,7 @@ gtk_file_chooser_native_set_accept_label (GtkFileChooserNative *self,
 
 /**
  * gtk_file_chooser_native_get_cancel_label:
- * @self: a #GtFileChooserNative
+ * @self: a #GtkFileChooserNative
  *
  * Retrieves the custom label text for the cancel button.
  *
@@ -278,7 +278,7 @@ gtk_file_chooser_native_get_cancel_label (GtkFileChooserNative *self)
 
 /**
  * gtk_file_chooser_native_set_cancel_label:
- * @self: a #GtFileChooserNative
+ * @self: a #GtkFileChooserNative
  * @cancel_label: (allow-none): custom label or %NULL for the default
  *
  * Sets the custom label text for the cancel button.
diff --git a/gtk/gtkmain.c b/gtk/gtkmain.c
index 06a974a..4364e79 100644
--- a/gtk/gtkmain.c
+++ b/gtk/gtkmain.c
@@ -2420,6 +2420,7 @@ gtk_get_event_target (const GdkEvent *event)
 /**
  * gtk_get_event_target_with_type:
  * @event: a #GdkEvent
+ * @type: the type to look for
  *
  * If @event is %NULL or the event was not associated with any widget,
  * returns %NULL, otherwise returns first widget found from the event
diff --git a/gtk/gtkorientable.c b/gtk/gtkorientable.c
index 0607211..f66fe04 100644
--- a/gtk/gtkorientable.c
+++ b/gtk/gtkorientable.c
@@ -33,9 +33,7 @@
  * @Title: GtkOrientable
  *
  * The #GtkOrientable interface is implemented by all widgets that can be
- * oriented horizontally or vertically. Historically, such widgets have been
- * realized as subclasses of a common base class (e.g #GtkBox/#GtkHBox/#GtkVBox
- * or #GtkScale/#GtkHScale/#GtkVScale). #GtkOrientable is more flexible in that
+ * oriented horizontally or vertically. #GtkOrientable is more flexible in that
  * it allows the orientation to be changed at runtime, allowing the widgets
  * to “flip”.
  *


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