[gimp] libgimpwidgets: some docs fixes



commit ea4fe02a6d8a89a0e232c0e95d9e889978e392fb
Author: Michael Natterer <mitch gimp org>
Date:   Sun Aug 18 14:07:17 2019 +0200

    libgimpwidgets: some docs fixes

 libgimpwidgets/gimpcolordisplay.c      |  8 +++----
 libgimpwidgets/gimpcolordisplaystack.c | 14 +++++------
 libgimpwidgets/gimpcolorselector.c     |  1 +
 libgimpwidgets/gimpwidgets.h           | 43 +++++++++++++++-------------------
 libgimpwidgets/gimpwidgetsutils.c      |  1 +
 5 files changed, 32 insertions(+), 35 deletions(-)
---
diff --git a/libgimpwidgets/gimpcolordisplay.c b/libgimpwidgets/gimpcolordisplay.c
index 8f5e385e98..3a82b0300d 100644
--- a/libgimpwidgets/gimpcolordisplay.c
+++ b/libgimpwidgets/gimpcolordisplay.c
@@ -296,7 +296,7 @@ gimp_color_display_set_color_managed (GimpColorDisplay *display,
  *
  * Returns: (transfer full): a duplicate of @display.
  *
- * Since: 1.3.10
+ * Since: 2.0
  **/
 GimpColorDisplay *
 gimp_color_display_clone (GimpColorDisplay *display)
@@ -345,7 +345,7 @@ gimp_color_display_convert_buffer (GimpColorDisplay *display,
  * @state must be a properly serialized configuration for a
  * #GimpColorDisplay, such as saved by gimp_color_display_save_state().
  *
- * Since: 1.3.10
+ * Since: 2.0
  **/
 void
 gimp_color_display_load_state (GimpColorDisplay *display,
@@ -368,7 +368,7 @@ gimp_color_display_load_state (GimpColorDisplay *display,
  *
  * Returns: (transfer full): a #GimpParasite
  *
- * Since: 1.3.10
+ * Since: 2.0
  **/
 GimpParasite *
 gimp_color_display_save_state (GimpColorDisplay *display)
@@ -398,7 +398,7 @@ gimp_color_display_save_state (GimpColorDisplay *display)
  * Returns: (transfer full): a new configuration widget for @display, or
  *          %NULL if no specific widget exists.
  *
- * Since: 1.3.10
+ * Since: 2.0
  **/
 GtkWidget *
 gimp_color_display_configure (GimpColorDisplay *display)
diff --git a/libgimpwidgets/gimpcolordisplaystack.c b/libgimpwidgets/gimpcolordisplaystack.c
index 061db6ffd6..d5776e8a29 100644
--- a/libgimpwidgets/gimpcolordisplaystack.c
+++ b/libgimpwidgets/gimpcolordisplaystack.c
@@ -175,7 +175,7 @@ gimp_color_display_stack_dispose (GObject *object)
  *
  * Returns: (transfer full): a newly allocated #GimpColorDisplayStack.
  *
- * Since: 1.3.23
+ * Since: 2.0
  **/
 GimpColorDisplayStack *
 gimp_color_display_stack_new (void)
@@ -192,7 +192,7 @@ gimp_color_display_stack_new (void)
  *
  * Returns: (transfer full): a duplicate of @stack.
  *
- * Since: 1.3.23
+ * Since: 2.0
  **/
 GimpColorDisplayStack *
 gimp_color_display_stack_clone (GimpColorDisplayStack *stack)
@@ -226,7 +226,7 @@ gimp_color_display_stack_clone (GimpColorDisplayStack *stack)
  *
  * Emit the "changed" signal of @stack.
  *
- * Since: 1.3.23
+ * Since: 2.0
  **/
 void
 gimp_color_display_stack_changed (GimpColorDisplayStack *stack)
@@ -262,7 +262,7 @@ gimp_color_display_stack_get_filters (GimpColorDisplayStack *stack)
  *
  * Add the color module @display to @stack.
  *
- * Since: 1.3.23
+ * Since: 2.0
  **/
 void
 gimp_color_display_stack_add (GimpColorDisplayStack *stack,
@@ -299,7 +299,7 @@ gimp_color_display_stack_add (GimpColorDisplayStack *stack,
  *
  * Remove the color module @display from @stack.
  *
- * Since: 1.3.23
+ * Since: 2.0
  **/
 void
 gimp_color_display_stack_remove (GimpColorDisplayStack *stack,
@@ -332,7 +332,7 @@ gimp_color_display_stack_remove (GimpColorDisplayStack *stack,
  *
  * Move the color module @display up in the filter list of @stack.
  *
- * Since: 1.3.23
+ * Since: 2.0
  **/
 void
 gimp_color_display_stack_reorder_up (GimpColorDisplayStack *stack,
@@ -369,7 +369,7 @@ gimp_color_display_stack_reorder_up (GimpColorDisplayStack *stack,
  *
  * Move the color module @display down in the filter list of @stack.
  *
- * Since: 1.3.23
+ * Since: 2.0
  **/
 void
 gimp_color_display_stack_reorder_down (GimpColorDisplayStack *stack,
diff --git a/libgimpwidgets/gimpcolorselector.c b/libgimpwidgets/gimpcolorselector.c
index ede81c5334..55c274fcbd 100644
--- a/libgimpwidgets/gimpcolorselector.c
+++ b/libgimpwidgets/gimpcolorselector.c
@@ -596,6 +596,7 @@ gimp_color_selector_channel_changed (GimpColorSelector *selector)
 /**
  * gimp_color_selector_model_visible_changed:
  * @selector: A #GimpColorSelector widget.
+ * @model:    The #GimpColorSelectorModel where visibility changed.
  *
  * Emits the "model-visible-changed" signal.
  *
diff --git a/libgimpwidgets/gimpwidgets.h b/libgimpwidgets/gimpwidgets.h
index c0ae558686..bbf043d778 100644
--- a/libgimpwidgets/gimpwidgets.h
+++ b/libgimpwidgets/gimpwidgets.h
@@ -93,49 +93,44 @@ G_BEGIN_DECLS
  *  Widget Constructors
  */
 
+/* specify radio buttons as va_list:
+ *  const gchar  *label,
+ *  gint          item_data,
+ *  GtkWidget   **widget_ptr,
+ */
 GtkWidget * gimp_int_radio_group_new (gboolean          in_frame,
                                       const gchar      *frame_title,
                                       GCallback         radio_button_callback,
                                       gpointer          radio_button_callback_data,
                                       gint              initial, /* item_data */
-
-                                      /* specify radio buttons as va_list:
-                                       *  const gchar  *label,
-                                       *  gint          item_data,
-                                       *  GtkWidget   **widget_ptr,
-                                       */
-
                                       ...) G_GNUC_NULL_TERMINATED;
 
 void        gimp_int_radio_group_set_active (GtkRadioButton *radio_button,
                                              gint            item_data);
 
 
+/* specify radio buttons as va_list:
+ *  const gchar    *label,
+ *  GCallback       callback,
+ *  gpointer        callback_data,
+ *  gpointer        item_data,
+ *  GtkWidget     **widget_ptr,
+ *  gboolean        active,
+ */
 GtkWidget * gimp_radio_group_new   (gboolean            in_frame,
                                     const gchar        *frame_title,
-
-                                    /* specify radio buttons as va_list:
-                                     *  const gchar    *label,
-                                     *  GCallback       callback,
-                                     *  gpointer        callback_data,
-                                     *  gpointer        item_data,
-                                     *  GtkWidget     **widget_ptr,
-                                     *  gboolean        active,
-                                     */
-
                                     ...) G_GNUC_NULL_TERMINATED;
+
+/* specify radio buttons as va_list:
+ *  const gchar    *label,
+ *  gpointer        item_data,
+ *  GtkWidget     **widget_ptr,
+ */
 GtkWidget * gimp_radio_group_new2  (gboolean            in_frame,
                                     const gchar        *frame_title,
                                     GCallback           radio_button_callback,
                                     gpointer            radio_button_callback_data,
                                     gpointer            initial, /* item_data */
-
-                                    /* specify radio buttons as va_list:
-                                     *  const gchar    *label,
-                                     *  gpointer        item_data,
-                                     *  GtkWidget     **widget_ptr,
-                                     */
-
                                     ...) G_GNUC_NULL_TERMINATED;
 
 void   gimp_radio_group_set_active (GtkRadioButton     *radio_button,
diff --git a/libgimpwidgets/gimpwidgetsutils.c b/libgimpwidgets/gimpwidgetsutils.c
index 4324d26272..1f98e17f2e 100644
--- a/libgimpwidgets/gimpwidgetsutils.c
+++ b/libgimpwidgets/gimpwidgetsutils.c
@@ -415,6 +415,7 @@ track_monitor_hierarchy_changed (GtkWidget        *widget,
  * @widget:                   a #GtkWidget
  * @monitor_changed_callback: the callback when @widget's monitor changes
  * @user_data:                data passed to @monitor_changed_callback
+ * @user_data_destroy:        destroy function for @user_data.
  *
  * This function behaves as if #GtkWidget had a signal
  *


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