[gimp] libgimpwidgets: more docs and annotations for GimpUnitComboBox



commit 00bf76752c8a6ee0cc5af573718eaded8f0f4e65
Author: Michael Natterer <mitch gimp org>
Date:   Thu Aug 8 00:40:03 2019 +0200

    libgimpwidgets: more docs and annotations for GimpUnitComboBox

 libgimpwidgets/gimpunitcombobox.c | 17 ++++++++++++++++-
 1 file changed, 16 insertions(+), 1 deletion(-)
---
diff --git a/libgimpwidgets/gimpunitcombobox.c b/libgimpwidgets/gimpunitcombobox.c
index 759fc26ba3..032b0b5426 100644
--- a/libgimpwidgets/gimpunitcombobox.c
+++ b/libgimpwidgets/gimpunitcombobox.c
@@ -139,7 +139,7 @@ gimp_unit_combo_box_new (void)
 
 /**
  * gimp_unit_combo_box_new_with_model:
- * @model: a GimpUnitStore
+ * @model: a #GimpUnitStore
  *
  * Returns: a new #GimpUnitComboBox.
  **/
@@ -151,6 +151,14 @@ gimp_unit_combo_box_new_with_model (GimpUnitStore *model)
                        NULL);
 }
 
+/**
+ * gimp_unit_combo_box_get_active:
+ * @combo: a #GimpUnitComboBox
+ *
+ * Returns the #GimpUnit currently selected in the combo box.
+ *
+ * Returns: (transfer none): The selected #GimpUnit.
+ **/
 GimpUnit
 gimp_unit_combo_box_get_active (GimpUnitComboBox *combo)
 {
@@ -168,6 +176,13 @@ gimp_unit_combo_box_get_active (GimpUnitComboBox *combo)
   return (GimpUnit) unit;
 }
 
+/**
+ * gimp_unit_combo_box_set_active:
+ * @combo: a #GimpUnitComboBox
+ * @unit:  a #GimpUnit
+ *
+ * Sets @unit as the currently selected #GimpUnit on @combo.
+ **/
 void
 gimp_unit_combo_box_set_active (GimpUnitComboBox *combo,
                                 GimpUnit          unit)


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