[gimp] libgimpwidgets: fix most gtk-doc warnings
- From: Michael Natterer <mitch src gnome org>
- To: commits-list gnome org
- Cc:
- Subject: [gimp] libgimpwidgets: fix most gtk-doc warnings
- Date: Mon, 5 Jul 2010 17:04:42 +0000 (UTC)
commit b3ee51794dd25c4817add305708d3d99ca27f6d2
Author: Michael Natterer <mitch gimp org>
Date: Mon Jul 5 19:04:15 2010 +0200
libgimpwidgets: fix most gtk-doc warnings
.../libgimpwidgets/libgimpwidgets-sections.txt | 1 +
libgimpwidgets/gimpcairo-utils.c | 4 +-
libgimpwidgets/gimpcellrenderertoggle.c | 6 +-
libgimpwidgets/gimpcolorbutton.c | 12 ++--
libgimpwidgets/gimpcolorprofilestore.c | 4 +-
libgimpwidgets/gimpcolorselection.c | 4 +-
libgimpwidgets/gimpcolorselector.c | 4 +-
libgimpwidgets/gimpcontroller.h | 8 ++
libgimpwidgets/gimpenumcombobox.c | 3 +-
libgimpwidgets/gimpenumwidgets.c | 82 ++++++++++----------
libgimpwidgets/gimpfileentry.c | 8 +-
libgimpwidgets/gimpintstore.h | 12 +++
libgimpwidgets/gimpnumberpairentry.c | 4 +
libgimpwidgets/gimpnumberpairentry.h | 8 +-
libgimpwidgets/gimppageselector.c | 11 ++-
libgimpwidgets/gimppreview.c | 8 +-
libgimpwidgets/gimppropwidgets.c | 16 ++--
libgimpwidgets/gimpquerybox.h | 4 +-
libgimpwidgets/gimpscaleentry.c | 2 +-
libgimpwidgets/gimpscaleentry.h | 10 +-
libgimpwidgets/gimpsizeentry.c | 21 +++---
libgimpwidgets/gimpstringcombobox.c | 2 +-
libgimpwidgets/gimpunitmenu.c | 2 +-
libgimpwidgets/gimpwidgets.c | 14 ++--
libgimpwidgets/gimpwidgets.h | 10 +-
libgimpwidgets/gimpwidgetsenums.h | 64 ++++++++++++++--
libgimpwidgets/gimpzoommodel.c | 2 +-
27 files changed, 202 insertions(+), 124 deletions(-)
---
diff --git a/devel-docs/libgimpwidgets/libgimpwidgets-sections.txt b/devel-docs/libgimpwidgets/libgimpwidgets-sections.txt
index c30da7b..f789cc3 100644
--- a/devel-docs/libgimpwidgets/libgimpwidgets-sections.txt
+++ b/devel-docs/libgimpwidgets/libgimpwidgets-sections.txt
@@ -938,6 +938,7 @@ gimp_unit_menu_update
gimp_table_attach_aligned
gimp_label_set_attributes
GIMP_WIDGETS_ERROR
+gimp_widgets_error_quark
</SECTION>
<SECTION>
diff --git a/libgimpwidgets/gimpcairo-utils.c b/libgimpwidgets/gimpcairo-utils.c
index d55ab39..02868f5 100644
--- a/libgimpwidgets/gimpcairo-utils.c
+++ b/libgimpwidgets/gimpcairo-utils.c
@@ -196,13 +196,15 @@ gimp_cairo_checkerboard_create (cairo_t *cr,
/**
* gimp_cairo_surface_create_from_pixbuf:
- * @pixbuf: a GdkPixbuf
+ * @pixbuf: a #GdkPixbuf
*
* Create a Cairo image surface from a GdkPixbuf.
*
* You should avoid calling this function as there are probably more
* efficient ways of achieving the result you are looking for.
*
+ * Returns: a #cairo_surface_t.
+ *
* Since: GIMP 2.6
**/
cairo_surface_t *
diff --git a/libgimpwidgets/gimpcellrenderertoggle.c b/libgimpwidgets/gimpcellrenderertoggle.c
index d9c4550..06bd921 100644
--- a/libgimpwidgets/gimpcellrenderertoggle.c
+++ b/libgimpwidgets/gimpcellrenderertoggle.c
@@ -446,9 +446,9 @@ gimp_cell_renderer_toggle_new (const gchar *stock_id)
/**
* gimp_cell_renderer_toggle_clicked:
- * @cell: a #GimpCellRendererToggle
- * @path:
- * @state:
+ * @cell: a #GimpCellRendererToggle
+ * @path: the path to the clicked row
+ * @state: the modifier state
*
* Emits the "clicked" signal from a #GimpCellRendererToggle.
*
diff --git a/libgimpwidgets/gimpcolorbutton.c b/libgimpwidgets/gimpcolorbutton.c
index 1a3be71..32c5437 100644
--- a/libgimpwidgets/gimpcolorbutton.c
+++ b/libgimpwidgets/gimpcolorbutton.c
@@ -548,11 +548,11 @@ gimp_color_button_get_action_type (GimpColorButton *button)
/**
* gimp_color_button_new:
- * @title: String that will be used as title for the color_selector.
- * @width: Width of the colorpreview in pixels.
+ * @title: String that will be used as title for the color_selector.
+ * @width: Width of the colorpreview in pixels.
* @height: Height of the colorpreview in pixels.
- * @color: A pointer to a #GimpRGB color.
- * @type:
+ * @color: A pointer to a #GimpRGB color.
+ * @type: The type of transparency to be displayed.
*
* Creates a new #GimpColorButton widget.
*
@@ -589,7 +589,7 @@ gimp_color_button_new (const gchar *title,
/**
* gimp_color_button_set_color:
* @button: Pointer to a #GimpColorButton.
- * @color: Pointer to the new #GimpRGB color.
+ * @color: Pointer to the new #GimpRGB color.
*
* Sets the @button to the given @color.
**/
@@ -608,7 +608,7 @@ gimp_color_button_set_color (GimpColorButton *button,
/**
* gimp_color_button_get_color:
* @button: Pointer to a #GimpColorButton.
- * @color: Pointer to a #GimpRGB struct used to return the color.
+ * @color: Pointer to a #GimpRGB struct used to return the color.
*
* Retrieves the currently set color from the @button.
**/
diff --git a/libgimpwidgets/gimpcolorprofilestore.c b/libgimpwidgets/gimpcolorprofilestore.c
index 2337fb9..0e0c043 100644
--- a/libgimpwidgets/gimpcolorprofilestore.c
+++ b/libgimpwidgets/gimpcolorprofilestore.c
@@ -39,9 +39,9 @@
/**
* SECTION: gimpcolorprofilestore
* @title: GimpColorProfileStore
- * @short_description: A #GtklistStore subclass that keep color profiles.
+ * @short_description: A #GtkListStore subclass that keep color profiles.
*
- * A #GtklistStore subclass that keep color profiles.
+ * A #GtkListStore subclass that keep color profiles.
**/
diff --git a/libgimpwidgets/gimpcolorselection.c b/libgimpwidgets/gimpcolorselection.c
index 6d979c5..f4d94b8 100644
--- a/libgimpwidgets/gimpcolorselection.c
+++ b/libgimpwidgets/gimpcolorselection.c
@@ -515,8 +515,8 @@ gimp_color_selection_color_changed (GimpColorSelection *selection)
/**
* gimp_color_selection_set_config:
- * @selection:
- * @config:
+ * @selection: A #GimpColorSelection widget.
+ * @config: A #GimpColorConfig object.
*
* Sets the color management configuration to use with this color selection.
*
diff --git a/libgimpwidgets/gimpcolorselector.c b/libgimpwidgets/gimpcolorselector.c
index e13d643..16299ee 100644
--- a/libgimpwidgets/gimpcolorselector.c
+++ b/libgimpwidgets/gimpcolorselector.c
@@ -254,8 +254,8 @@ gimp_color_selector_channel_changed (GimpColorSelector *selector)
/**
* gimp_color_selector_set_config:
- * @selector:
- * @config:
+ * @selector: a #GimpColorSelector widget.
+ * @config: a #GimpColorConfig object.
*
* Sets the color management configuration to use with this color selector.
*
diff --git a/libgimpwidgets/gimpcontroller.h b/libgimpwidgets/gimpcontroller.h
index 3f1ae14..da48a3a 100644
--- a/libgimpwidgets/gimpcontroller.h
+++ b/libgimpwidgets/gimpcontroller.h
@@ -31,12 +31,20 @@ G_BEGIN_DECLS
/* For information look at the html documentation */
+/**
+ * GimpControllerEventType:
+ * @GIMP_CONTROLLER_EVENT_TRIGGER: the event is a simple trigger
+ * @GIMP_CONTROLLER_EVENT_VALUE: the event carries a double value
+ *
+ * Event types for #GimpController.
+ **/
typedef enum
{
GIMP_CONTROLLER_EVENT_TRIGGER,
GIMP_CONTROLLER_EVENT_VALUE
} GimpControllerEventType;
+
typedef struct _GimpControllerEventAny GimpControllerEventAny;
typedef struct _GimpControllerEventTrigger GimpControllerEventTrigger;
typedef struct _GimpControllerEventValue GimpControllerEventValue;
diff --git a/libgimpwidgets/gimpenumcombobox.c b/libgimpwidgets/gimpenumcombobox.c
index d3d7986..456eb53 100644
--- a/libgimpwidgets/gimpenumcombobox.c
+++ b/libgimpwidgets/gimpenumcombobox.c
@@ -188,7 +188,8 @@ gimp_enum_combo_box_new_with_model (GimpEnumStore *enum_store)
* @stock_prefix: a prefix to create icon stock ID from enum values
*
* Attempts to create stock icons for all items in the @combo_box. See
- * gimp_enum_store_set_icons() to find out what to use as @stock_prefix.
+ * gimp_enum_store_set_stock_prefix() to find out what to use as
+ * @stock_prefix.
*
* Since: GIMP 2.4
**/
diff --git a/libgimpwidgets/gimpenumwidgets.c b/libgimpwidgets/gimpenumwidgets.c
index abaf973..1260e28 100644
--- a/libgimpwidgets/gimpenumwidgets.c
+++ b/libgimpwidgets/gimpenumwidgets.c
@@ -44,11 +44,11 @@
/**
* gimp_enum_radio_box_new:
- * @enum_type: the #GType of an enum.
- * @callback: a callback to connect to the "toggled" signal of each
- * #GtkRadioButton that is created.
+ * @enum_type: the #GType of an enum.
+ * @callback: a callback to connect to the "toggled" signal of each
+ * #GtkRadioButton that is created.
* @callback_data: data to pass to the @callback.
- * @first_button: returns the first button in the created group.
+ * @first_button: returns the first button in the created group.
*
* Creates a new group of #GtkRadioButtons representing the enum
* values. A group of radiobuttons is a good way to represent enums
@@ -85,13 +85,13 @@ gimp_enum_radio_box_new (GType enum_type,
/**
* gimp_enum_radio_box_new_with_range:
- * @minimum:
- * @maximum:
- * @enum_type: the #GType of an enum.
- * @callback: a callback to connect to the "toggled" signal of each
- * #GtkRadioButton that is created.
+ * @minimum: the minimum enum value
+ * @maximum: the maximum enum value
+ * @enum_type: the #GType of an enum.
+ * @callback: a callback to connect to the "toggled" signal of each
+ * #GtkRadioButton that is created.
* @callback_data: data to pass to the @callback.
- * @first_button: returns the first button in the created group.
+ * @first_button: returns the first button in the created group.
*
* Just like gimp_enum_radio_box_new(), this function creates a group
* of radio buttons, but it allows to limit the range of available
@@ -158,13 +158,13 @@ gimp_enum_radio_box_new_with_range (GType enum_type,
/**
* gimp_enum_radio_frame_new:
- * @enum_type: the #GType of an enum.
- * @label_widget: a widget to use as label for the frame that will
- * hold the radio box.
- * @callback: a callback to connect to the "toggled" signal of each
- * #GtkRadioButton that is created.
+ * @enum_type: the #GType of an enum.
+ * @label_widget: a widget to use as label for the frame that will
+ * hold the radio box.
+ * @callback: a callback to connect to the "toggled" signal of each
+ * #GtkRadioButton that is created.
* @callback_data: data to pass to the @callback.
- * @first_button: returns the first button in the created group.
+ * @first_button: returns the first button in the created group.
*
* Calls gimp_enum_radio_box_new() and puts the resulting vbox into a
* #GtkFrame.
@@ -206,14 +206,14 @@ gimp_enum_radio_frame_new (GType enum_type,
/**
* gimp_enum_radio_frame_new_with_range:
- * @enum_type: the #GType of an enum.
- * @minimum:
- * @maximum:
- * @label_widget: a widget to put into the frame that will hold the radio box.
- * @callback: a callback to connect to the "toggled" signal of each
- * #GtkRadioButton that is created.
+ * @enum_type: the #GType of an enum.
+ * @minimum: the minimum enum value
+ * @maximum: the maximum enum value
+ * @label_widget: a widget to put into the frame that will hold the radio box.
+ * @callback: a callback to connect to the "toggled" signal of each
+ * #GtkRadioButton that is created.
* @callback_data: data to pass to the @callback.
- * @first_button: returns the first button in the created group.
+ * @first_button: returns the first button in the created group.
*
* Calls gimp_enum_radio_box_new_with_range() and puts the resulting
* vbox into a #GtkFrame.
@@ -260,19 +260,19 @@ gimp_enum_radio_frame_new_with_range (GType enum_type,
/**
* gimp_enum_stock_box_new:
- * @enum_type: the #GType of an enum.
- * @stock_prefix: the prefix of the group of stock ids to use.
- * @icon_size:
- * @callback: a callback to connect to the "toggled" signal of each
- * #GtkRadioButton that is created.
+ * @enum_type: the #GType of an enum.
+ * @stock_prefix: the prefix of the group of stock ids to use.
+ * @icon_size: the icon size for the stock icons
+ * @callback: a callback to connect to the "toggled" signal of each
+ * #GtkRadioButton that is created.
* @callback_data: data to pass to the @callback.
- * @first_button: returns the first button in the created group.
+ * @first_button: returns the first button in the created group.
*
* Creates a horizontal box of radio buttons with stock icons. The
* stock_id for each icon is created by appending the enum_value's
* nick to the given @stock_prefix.
*
- * Return value: a new #GtkHbox holding a group of #GtkRadioButtons.
+ * Return value: a new #GtkHBox holding a group of #GtkRadioButtons.
*
* Since: GIMP 2.4
**/
@@ -305,21 +305,21 @@ gimp_enum_stock_box_new (GType enum_type,
/**
* gimp_enum_stock_box_new_with_range:
- * @enum_type: the #GType of an enum.
- * @minimum:
- * @maximum:
- * @stock_prefix: the prefix of the group of stock ids to use.
- * @icon_size:
- * @callback: a callback to connect to the "toggled" signal of each
- * #GtkRadioButton that is created.
+ * @enum_type: the #GType of an enum.
+ * @minimum: the minumim enum value
+ * @maximum: the maximum enum value
+ * @stock_prefix: the prefix of the group of stock ids to use.
+ * @icon_size: the icon size for the stock icons
+ * @callback: a callback to connect to the "toggled" signal of each
+ * #GtkRadioButton that is created.
* @callback_data: data to pass to the @callback.
- * @first_button: returns the first button in the created group.
+ * @first_button: returns the first button in the created group.
*
* Just like gimp_enum_stock_box_new(), this function creates a group
* of radio buttons, but it allows to limit the range of available
* enum values.
*
- * Return value: a new #GtkHbox holding a group of #GtkRadioButtons.
+ * Return value: a new #GtkHBox holding a group of #GtkRadioButtons.
*
* Since: GIMP 2.4
**/
@@ -401,8 +401,8 @@ gimp_enum_stock_box_new_with_range (GType enum_type,
/**
* gimp_enum_stock_box_set_child_padding:
* @stock_box: a stock box widget
- * @xpad: horizontal padding
- * @ypad: vertical padding
+ * @xpad: horizontal padding
+ * @ypad: vertical padding
*
* Sets the padding of all buttons in a box created by
* gimp_enum_stock_box_new().
diff --git a/libgimpwidgets/gimpfileentry.c b/libgimpwidgets/gimpfileentry.c
index 6992374..c87a165 100644
--- a/libgimpwidgets/gimpfileentry.c
+++ b/libgimpwidgets/gimpfileentry.c
@@ -44,11 +44,11 @@
* This widget is used to enter filenames or directories.
*
* There is a #GtkEntry for entering the filename manually and a "..."
- * button which will pop up a #GtkFileSelection dialog.
+ * button which will pop up a #GtkFileChooserDialog.
*
- * You can restrict the #GimpFileSelection to directories. In this
+ * You can restrict the #GimpFileEntry to directories. In this
* case the filename listbox of the #GtkFileChooser dialog will be
- * hidden.
+ * set to directory mode.
*
* If you specify @check_valid as #TRUE in gimp_file_entry_new() the
* entered filename will be checked for validity and a pixmap will be
@@ -168,7 +168,7 @@ gimp_file_entry_destroy (GtkObject *object)
/**
* gimp_file_entry_new:
- * @title: The title of the #GtkFileEntry dialog.
+ * @title: The title of the #GimpFileEntry dialog.
* @filename: The initial filename.
* @dir_only: %TRUE if the file entry should accept directories only.
* @check_valid: %TRUE if the widget should check if the entered file
diff --git a/libgimpwidgets/gimpintstore.h b/libgimpwidgets/gimpintstore.h
index fedef0b..567fb72 100644
--- a/libgimpwidgets/gimpintstore.h
+++ b/libgimpwidgets/gimpintstore.h
@@ -24,6 +24,18 @@
G_BEGIN_DECLS
+
+/**
+ * GimpIntStoreColumns:
+ * @GIMP_INT_STORE_VALUE: the integer value
+ * @GIMP_INT_STORE_LABEL: a human-readable label
+ * @GIMP_INT_STORE_STOCK_ID: a stock ID
+ * @GIMP_INT_STORE_PIXBUF: a #GdkPixbuf
+ * @GIMP_INT_STORE_USER_DATA: arbitrary user data
+ * @GIMP_INT_STORE_NUM_COLUMNS: the number of columns
+ *
+ * The column types of #GimpIntStore.
+ **/
typedef enum
{
GIMP_INT_STORE_VALUE,
diff --git a/libgimpwidgets/gimpnumberpairentry.c b/libgimpwidgets/gimpnumberpairentry.c
index f2f301e..c47bba2 100644
--- a/libgimpwidgets/gimpnumberpairentry.c
+++ b/libgimpwidgets/gimpnumberpairentry.c
@@ -338,6 +338,10 @@ gimp_number_pair_entry_finalize (GObject *object)
/**
* gimp_number_pair_entry_new:
+ * @separators: The allowed separators.
+ * @allow_simplification: Whether to do simplification on the entered term.
+ * @min_valid_value: The minimum allowed result value.
+ * @max_valid_value: The maximum allowed result value.
*
* Creates a new #GimpNumberPairEntry widget, which is a GtkEntry that
* accepts two numbers separated by a separator. Typical input example
diff --git a/libgimpwidgets/gimpnumberpairentry.h b/libgimpwidgets/gimpnumberpairentry.h
index cf7c3b8..d20c8be 100644
--- a/libgimpwidgets/gimpnumberpairentry.h
+++ b/libgimpwidgets/gimpnumberpairentry.h
@@ -21,8 +21,8 @@
* <http://www.gnu.org/licenses/>.
*/
-#ifndef GIMP_NUMBER_PAIR_ENTRY_H
-#define GIMP_NUMBER_PAIR_ENTRY_H
+#ifndef __GIMP_NUMBER_PAIR_ENTRY_H__
+#define __GIMP_NUMBER_PAIR_ENTRY_H__
G_BEGIN_DECLS
@@ -95,8 +95,6 @@ void gimp_number_pair_entry_set_user_override (GimpNumberPairEntry *e
gboolean gimp_number_pair_entry_get_user_override (GimpNumberPairEntry *entry);
-
-
G_END_DECLS
-#endif /* GIMP_NUMBER_PAIR_ENTRY_H */
+#endif /* __GIMP_NUMBER_PAIR_ENTRY_H__ */
diff --git a/libgimpwidgets/gimppageselector.c b/libgimpwidgets/gimppageselector.c
index 79475b8..b368e11 100644
--- a/libgimpwidgets/gimppageselector.c
+++ b/libgimpwidgets/gimppageselector.c
@@ -607,7 +607,7 @@ gimp_page_selector_get_target (GimpPageSelector *selector)
* @page_no: The number of the page to set the thumbnail for.
* @thumbnail: The thumbnail pixbuf.
*
- * Sets the thumbnail for given %page_no. A default "page" icon will
+ * Sets the thumbnail for given @page_no. A default "page" icon will
* be used if no page thumbnail is set.
*
* Since: GIMP 2.4
@@ -728,9 +728,10 @@ gimp_page_selector_get_page_thumbnail (GimpPageSelector *selector,
/**
* gimp_page_selector_set_page_label:
* @selector: Pointer to a #GimpPageSelector.
- * @page_no: The number of the page to set the label for.
- * @label: The label.
+ * @page_no: The number of the page to set the label for.
+ * @label: The label.
*
+ * Sets the label of the specified page.
*
* Since: GIMP 2.4
**/
@@ -998,7 +999,7 @@ gimp_page_selector_get_selected_pages (GimpPageSelector *selector,
* @selector: Pointer to a #GimpPageSelector.
* @range: A string representing the set of selected pages.
*
- * Selectes the pages described by %range. The range string is a
+ * Selectes the pages described by @range. The range string is a
* user-editable list of pages and ranges, e.g. "1,3,5-7,9-12,14".
* Note that the page numbering in the range string starts with 1,
* not 0.
@@ -1101,7 +1102,7 @@ gimp_page_selector_select_range (GimpPageSelector *selector,
* @selector: Pointer to a #GimpPageSelector.
*
* Returns: A newly allocated string representing the set of selected
- * pages. See gimp_page_selector_set_selected_range() for the
+ * pages. See gimp_page_selector_select_range() for the
* format of the string.
*
* Since: GIMP 2.4
diff --git a/libgimpwidgets/gimppreview.c b/libgimpwidgets/gimppreview.c
index 45170d8..f9736db 100644
--- a/libgimpwidgets/gimppreview.c
+++ b/libgimpwidgets/gimppreview.c
@@ -577,10 +577,10 @@ gimp_preview_get_update (GimpPreview *preview)
/**
* gimp_preview_set_bounds:
* @preview: a #GimpPreview widget
- * @xmin:
- * @ymin:
- * @xmax:
- * @ymax:
+ * @xmin: the minimum X value
+ * @ymin: the minimum Y value
+ * @xmax: the maximum X value
+ * @ymax: the maximum Y value
*
* Sets the lower and upper limits for the previewed area. The
* difference between the upper and lower value is used to set the
diff --git a/libgimpwidgets/gimppropwidgets.c b/libgimpwidgets/gimppropwidgets.c
index 196cbb0..0a10d68 100644
--- a/libgimpwidgets/gimppropwidgets.c
+++ b/libgimpwidgets/gimppropwidgets.c
@@ -901,7 +901,7 @@ gimp_prop_boolean_radio_frame_new (GObject *config,
* enum_value's nick to the given @stock_prefix. See
* gimp_enum_stock_box_new() for more information.
*
- * Return value: A #GimpEnumStockBox containing the radio buttons.
+ * Return value: A #libgimpwidgets-gimpenumstockbox containing the radio buttons.
*
* Since GIMP 2.4
*/
@@ -1018,7 +1018,7 @@ static void gimp_prop_adjustment_notify (GObject *config,
* Creates a spin button to set and display the value of the
* specified double property.
*
- * Return value: A new #GimpSpinButton.
+ * Return value: A new #libgimpwidgets-gimpspinbutton.
*
* Since GIMP 2.4
*/
@@ -1143,8 +1143,8 @@ gimp_prop_hscale_new (GObject *config,
* @lower_limit: The spinbutton's lower boundary if @limit_scale is %FALSE.
* @upper_limit: The spinbutton's upper boundary if @limit_scale is %FALSE.
*
- * Creates a #GimpScaleEntry (slider and spin button) to set and
- * display the value of the specified double property. See
+ * Creates a #libgimpwidgets-gimpscaleentry (slider and spin button)
+ * to set and display the value of the specified double property. See
* gimp_scale_entry_new() for more information.
*
* Return value: The #GtkSpinButton's #GtkAdjustment.
@@ -1229,10 +1229,10 @@ gimp_prop_scale_entry_new (GObject *config,
* @label: The text for the #GtkLabel which will appear left of the
* #GtkHScale.
*
- * Creates a #GimpScaleEntry (slider and spin button) to set and
- * display the value of the specified double property, which should
- * represent an "opacity" variable with range 0 to 100. See
- * gimp_scale_entry_new() for more information.
+ * Creates a #libgimpwidgets-gimpscaleentry (slider and spin button)
+ * to set and display the value of the specified double property,
+ * which should represent an "opacity" variable with range 0 to 100.
+ * See gimp_scale_entry_new() for more information.
*
* Return value: The #GtkSpinButton's #GtkAdjustment.
*
diff --git a/libgimpwidgets/gimpquerybox.h b/libgimpwidgets/gimpquerybox.h
index 6fa4b5c..f5bda6d 100644
--- a/libgimpwidgets/gimpquerybox.h
+++ b/libgimpwidgets/gimpquerybox.h
@@ -94,8 +94,8 @@ typedef void (* GimpQueryBooleanCallback) (GtkWidget *query_box,
* GIMP_QUERY_BOX_VBOX:
* @qbox: The query box.
*
- * A macro to access the #GtkVBox in a #GimpQueryBox. Useful if you
- * want to add more widgets.
+ * A macro to access the #GtkVBox in a #libgimpwidgets-gimpquerybox.
+ * Useful if you want to add more widgets.
**/
#define GIMP_QUERY_BOX_VBOX(qbox) g_object_get_data (G_OBJECT (qbox), \
"gimp-query-box-vbox")
diff --git a/libgimpwidgets/gimpscaleentry.c b/libgimpwidgets/gimpscaleentry.c
index 06ec424..b5c053d 100644
--- a/libgimpwidgets/gimpscaleentry.c
+++ b/libgimpwidgets/gimpscaleentry.c
@@ -525,7 +525,7 @@ gimp_scale_entry_get_logarithmic (GtkObject *adjustment)
* parameter of gtk_widget_set_sensitive()
*
* Sets the sensitivity of the scale_entry's #GtkLabel, #GtkHScale and
- * #GtkSpinbutton.
+ * #GtkSpinButton.
**/
void
gimp_scale_entry_set_sensitive (GtkObject *adjustment,
diff --git a/libgimpwidgets/gimpscaleentry.h b/libgimpwidgets/gimpscaleentry.h
index 6993a17..3ef65f6 100644
--- a/libgimpwidgets/gimpscaleentry.h
+++ b/libgimpwidgets/gimpscaleentry.h
@@ -30,7 +30,7 @@ G_BEGIN_DECLS
* GIMP_SCALE_ENTRY_LABEL:
* @adj: The #GtkAdjustment returned by gimp_scale_entry_new().
*
- * Returns the scale_entry's #GtkLabel.
+ * Returns: the scale_entry's #GtkLabel.
**/
#define GIMP_SCALE_ENTRY_LABEL(adj) \
(g_object_get_data (G_OBJECT (adj), "label"))
@@ -39,7 +39,7 @@ G_BEGIN_DECLS
* GIMP_SCALE_ENTRY_SCALE:
* @adj: The #GtkAdjustment returned by gimp_scale_entry_new().
*
- * Returns the scale_entry's #GtkHScale.
+ * Returns: the scale_entry's #GtkHScale.
**/
#define GIMP_SCALE_ENTRY_SCALE(adj) \
(g_object_get_data (G_OBJECT (adj), "scale"))
@@ -48,7 +48,7 @@ G_BEGIN_DECLS
* GIMP_SCALE_ENTRY_SCALE_ADJ:
* @adj: The #GtkAdjustment returned by gimp_scale_entry_new().
*
- * Returns the #GtkAdjustment of the scale_entry's #GtkHScale.
+ * Returns: the #GtkAdjustment of the scale_entry's #GtkHScale.
**/
#define GIMP_SCALE_ENTRY_SCALE_ADJ(adj) \
gtk_range_get_adjustment \
@@ -58,7 +58,7 @@ G_BEGIN_DECLS
* GIMP_SCALE_ENTRY_SPINBUTTON:
* @adj: The #GtkAdjustment returned by gimp_scale_entry_new().
*
- * Returns the scale_entry's #GtkSpinButton.
+ * Returns: the scale_entry's #GtkSpinButton.
**/
#define GIMP_SCALE_ENTRY_SPINBUTTON(adj) \
(g_object_get_data (G_OBJECT (adj), "spinbutton"))
@@ -67,7 +67,7 @@ G_BEGIN_DECLS
* GIMP_SCALE_ENTRY_SPINBUTTON_ADJ:
* @adj: The #GtkAdjustment returned by gimp_scale_entry_new().
*
- * Returns the #GtkAdjustment of the scale_entry's #GtkSpinButton.
+ * Returns: the #GtkAdjustment of the scale_entry's #GtkSpinButton.
**/
#define GIMP_SCALE_ENTRY_SPINBUTTON_ADJ(adj) \
gtk_spin_button_get_adjustment \
diff --git a/libgimpwidgets/gimpsizeentry.c b/libgimpwidgets/gimpsizeentry.c
index eccd7d0..0f5ca20 100644
--- a/libgimpwidgets/gimpsizeentry.c
+++ b/libgimpwidgets/gimpsizeentry.c
@@ -713,7 +713,7 @@ gimp_size_entry_set_value_boundaries (GimpSizeEntry *gse,
}
/**
- * gimp_size_entry_get_value;
+ * gimp_size_entry_get_value:
* @gse: The sizeentry you want to know a value of.
* @field: The index of the field you want to know the value of.
*
@@ -796,7 +796,7 @@ gimp_size_entry_update_value (GimpSizeEntryField *gsef,
}
/**
- * gimp_size_entry_set_value;
+ * gimp_size_entry_set_value:
* @gse: The sizeentry you want to set a value for.
* @field: The index of the field you want to set a value for.
* @value: The new value for @field.
@@ -976,7 +976,7 @@ gimp_size_entry_set_refval_digits (GimpSizeEntry *gse,
}
/**
- * gimp_size_entry_get_refval;
+ * gimp_size_entry_get_refval:
* @gse: The sizeentry you want to know a reference value of.
* @field: The index of the field you want to know the reference value of.
*
@@ -1054,7 +1054,7 @@ gimp_size_entry_update_refval (GimpSizeEntryField *gsef,
}
/**
- * gimp_size_entry_set_refval;
+ * gimp_size_entry_set_refval:
* @gse: The sizeentry you want to set a reference value for.
* @field: The index of the field you want to set the reference value for.
* @refval: The new reference value for @field.
@@ -1202,8 +1202,8 @@ gimp_size_entry_unit_callback (GtkWidget *widget,
/**
* gimp_size_entry_attach_eevl:
- * @spin_button:
- * @gsef:
+ * @spin_button: one of the size_entry's spinbuttons.
+ * @gsef: a size entry field.
*
* Hooks in the GimpEevl unit expression parser into the
* #GtkSpinButton of the #GimpSizeEntryField.
@@ -1212,10 +1212,9 @@ static void
gimp_size_entry_attach_eevl (GtkSpinButton *spin_button,
GimpSizeEntryField *gsef)
{
- gtk_spin_button_set_numeric (spin_button,
- FALSE);
- gtk_spin_button_set_update_policy (spin_button,
- GTK_UPDATE_IF_VALID);
+ gtk_spin_button_set_numeric (spin_button, FALSE);
+ gtk_spin_button_set_update_policy (spin_button, GTK_UPDATE_IF_VALID);
+
g_signal_connect (spin_button, "input",
G_CALLBACK (gimp_size_entry_eevl_input_callback),
gsef);
@@ -1433,7 +1432,7 @@ gimp_size_entry_grab_focus (GimpSizeEntry *gse)
/**
* gimp_size_entry_set_activates_default:
- * @gse: A #GimpSizeEntr
+ * @gse: A #GimpSizeEntry
* @setting: %TRUE to activate window's default widget on Enter keypress
*
* Iterates over all entries in the #GimpSizeEntry and calls
diff --git a/libgimpwidgets/gimpstringcombobox.c b/libgimpwidgets/gimpstringcombobox.c
index 1826d2e..847a62d 100644
--- a/libgimpwidgets/gimpstringcombobox.c
+++ b/libgimpwidgets/gimpstringcombobox.c
@@ -291,7 +291,7 @@ gimp_string_combo_box_new (GtkTreeModel *model,
/**
* gimp_string_combo_box_set_active:
* @combo_box: a #GimpStringComboBox
- * @id:
+ * @id: the ID of the item to select
*
* Looks up the item that belongs to the given @id and makes it the
* selected item in the @combo_box.
diff --git a/libgimpwidgets/gimpunitmenu.c b/libgimpwidgets/gimpunitmenu.c
index a407d03..2a9fe71 100644
--- a/libgimpwidgets/gimpunitmenu.c
+++ b/libgimpwidgets/gimpunitmenu.c
@@ -439,7 +439,7 @@ gimp_unit_menu_set_pixel_digits (GimpUnitMenu *menu,
* @menu: a #GimpUnitMenu
*
* Retrieve the number of digits for a pixel size as set by
- * gimp_unit_set_pixel_digits().
+ * gimp_unit_menu_set_pixel_digits().
*
* Return value: the configured number of digits for a pixel size
**/
diff --git a/libgimpwidgets/gimpwidgets.c b/libgimpwidgets/gimpwidgets.c
index 8b1ed44..7288186 100644
--- a/libgimpwidgets/gimpwidgets.c
+++ b/libgimpwidgets/gimpwidgets.c
@@ -59,9 +59,9 @@
* @...: A %NULL-terminated @va_list describing the radio buttons.
*
* Convenience function to create a group of radio buttons embedded into
- * a #GtkFrame or #GtkVbox.
+ * a #GtkFrame or #GtkVBox.
*
- * Returns: A #GtkFrame or #GtkVbox (depending on @in_frame).
+ * Returns: A #GtkFrame or #GtkVBox (depending on @in_frame).
**/
GtkWidget *
gimp_radio_group_new (gboolean in_frame,
@@ -168,9 +168,9 @@ gimp_radio_group_new (gboolean in_frame,
* the radio buttons.
*
* Convenience function to create a group of radio buttons embedded into
- * a #GtkFrame or #GtkVbox.
+ * a #GtkFrame or #GtkVBox.
*
- * Returns: A #GtkFrame or #GtkVbox (depending on @in_frame).
+ * Returns: A #GtkFrame or #GtkVBox (depending on @in_frame).
**/
GtkWidget *
gimp_radio_group_new2 (gboolean in_frame,
@@ -272,12 +272,12 @@ gimp_radio_group_new2 (gboolean in_frame,
* the radio buttons.
*
* Convenience function to create a group of radio buttons embedded into
- * a #GtkFrame or #GtkVbox. This function does the same thing as
+ * a #GtkFrame or #GtkVBox. This function does the same thing as
* gimp_radio_group_new2(), but it takes integers as @item_data instead of
* pointers, since that is a very common case (mapping an enum to a radio
* group).
*
- * Returns: A #GtkFrame or #GtkVbox (depending on @in_frame).
+ * Returns: A #GtkFrame or #GtkVBox (depending on @in_frame).
**/
GtkWidget *
gimp_int_radio_group_new (gboolean in_frame,
@@ -434,7 +434,7 @@ gimp_int_radio_group_set_active (GtkRadioButton *radio_button,
* gtk_spin_button_set_numeric() so that non-numeric text cannot be
* entered.
*
- * Returns: A #GtkSpinbutton and it's #GtkAdjustment.
+ * Returns: A #GtkSpinButton and its #GtkAdjustment.
**/
GtkWidget *
gimp_spin_button_new (GtkObject **adjustment, /* return value */
diff --git a/libgimpwidgets/gimpwidgets.h b/libgimpwidgets/gimpwidgets.h
index f32f062..57f9a25 100644
--- a/libgimpwidgets/gimpwidgets.h
+++ b/libgimpwidgets/gimpwidgets.h
@@ -153,7 +153,7 @@ GtkWidget * gimp_spin_button_new (/* return value: */
* GIMP_RANDOM_SEED_SPINBUTTON:
* @hbox: The #GtkHBox returned by gimp_random_seed_new().
*
- * Returns the random_seed's #GtkSpinButton.
+ * Returns: the random_seed's #GtkSpinButton.
**/
#define GIMP_RANDOM_SEED_SPINBUTTON(hbox) \
(g_object_get_data (G_OBJECT (hbox), "spinbutton"))
@@ -162,7 +162,7 @@ GtkWidget * gimp_spin_button_new (/* return value: */
* GIMP_RANDOM_SEED_SPINBUTTON_ADJ:
* @hbox: The #GtkHBox returned by gimp_random_seed_new().
*
- * Returns the #GtkAdjustment of the random_seed's #GtkSpinButton.
+ * Returns: the #GtkAdjustment of the random_seed's #GtkSpinButton.
**/
#define GIMP_RANDOM_SEED_SPINBUTTON_ADJ(hbox) \
gtk_spin_button_get_adjustment \
@@ -172,7 +172,7 @@ GtkWidget * gimp_spin_button_new (/* return value: */
* GIMP_RANDOM_SEED_TOGGLE:
* @hbox: The #GtkHBox returned by gimp_random_seed_new().
*
- * Returns the random_seed's #GtkToggleButton.
+ * Returns: the random_seed's #GtkToggleButton.
**/
#define GIMP_RANDOM_SEED_TOGGLE(hbox) \
(g_object_get_data (G_OBJECT(hbox), "toggle"))
@@ -184,8 +184,8 @@ GtkWidget * gimp_random_seed_new (guint32 *seed,
* GIMP_COORDINATES_CHAINBUTTON:
* @sizeentry: The #GimpSizeEntry returned by gimp_coordinates_new().
*
- * Returns the #GimpChainButton which is attached to the
- * #GimpSizeEntry.
+ * Returns: the #GimpChainButton which is attached to the
+ * #GimpSizeEntry.
**/
#define GIMP_COORDINATES_CHAINBUTTON(sizeentry) \
(g_object_get_data (G_OBJECT (sizeentry), "chainbutton"))
diff --git a/libgimpwidgets/gimpwidgetsenums.h b/libgimpwidgets/gimpwidgetsenums.h
index c3d45d1..a93c24d 100644
--- a/libgimpwidgets/gimpwidgetsenums.h
+++ b/libgimpwidgets/gimpwidgetsenums.h
@@ -25,6 +25,14 @@ G_BEGIN_DECLS
/* For information look into the C source or the html documentation */
+/**
+ * GimpAspectType:
+ * @GIMP_ASPECT_SQUARE: it's a 1:1 square
+ * @GIMP_ASPECT_PORTRAIT: it's higher than it's wide
+ * @GIMP_ASPECT_LANDSCAPE: it's wider than it's high
+ *
+ * Aspect ratios.
+ **/
#define GIMP_TYPE_ASPECT_TYPE (gimp_aspect_type_get_type ())
GType gimp_aspect_type_get_type (void) G_GNUC_CONST;
@@ -37,6 +45,15 @@ typedef enum
} GimpAspectType;
+/**
+ * GimpChainPosition:
+ * @GIMP_CHAIN_TOP: the chain is on top
+ * @GIMP_CHAIN_LEFT: the chain is to the left
+ * @GIMP_CHAIN_BOTTOM: the chain is on bottom
+ * @GIMP_CHAIN_RIGHT: the chain is to the right
+ *
+ * Possible chain positions for #GimpChainButton.
+ **/
#define GIMP_TYPE_CHAIN_POSITION (gimp_chain_position_get_type ())
GType gimp_chain_position_get_type (void) G_GNUC_CONST;
@@ -50,6 +67,14 @@ typedef enum
} GimpChainPosition;
+/**
+ * GimpColorAreaType:
+ * @GIMP_COLOR_AREA_FLAT: don't display transparency
+ * @GIMP_COLOR_AREA_SMALL_CHECKS: display transparency using small checks
+ * @GIMP_COLOR_AREA_LARGE_CHECKS: display transparency using large checks
+ *
+ * The types of transparency display for #GimpColorArea.
+ **/
#define GIMP_TYPE_COLOR_AREA_TYPE (gimp_color_area_type_get_type ())
GType gimp_color_area_type_get_type (void) G_GNUC_CONST;
@@ -64,13 +89,13 @@ typedef enum
/**
* GimpColorSelectorChannel:
- * @GIMP_COLOR_SELECTOR_HUE: the hue channel
+ * @GIMP_COLOR_SELECTOR_HUE: the hue channel
* @GIMP_COLOR_SELECTOR_SATURATION: the saturation channel
- * @GIMP_COLOR_SELECTOR_VALUE: the value channel
- * @GIMP_COLOR_SELECTOR_RED: the red channel
- * @GIMP_COLOR_SELECTOR_GREEN: the green channel
- * @GIMP_COLOR_SELECTOR_BLUE: the blue channel
- * @GIMP_COLOR_SELECTOR_ALPHA: the alpha channel
+ * @GIMP_COLOR_SELECTOR_VALUE: the value channel
+ * @GIMP_COLOR_SELECTOR_RED: the red channel
+ * @GIMP_COLOR_SELECTOR_GREEN: the green channel
+ * @GIMP_COLOR_SELECTOR_BLUE: the blue channel
+ * @GIMP_COLOR_SELECTOR_ALPHA: the alpha channel
*
* An enum to specify the types of color channels edited in
* #GimpColorSelector widgets.
@@ -91,6 +116,13 @@ typedef enum
} GimpColorSelectorChannel;
+/**
+ * GimpPageSelectorTarget:
+ * @GIMP_PAGE_SELECTOR_TARGET_LAYERS: import as layers of one image
+ * @GIMP_PAGE_SELECTOR_TARGET_IMAGES: import as separate images
+ *
+ * Import targets for #GimpPageSelector.
+ **/
#define GIMP_TYPE_PAGE_SELECTOR_TARGET (gimp_page_selector_target_get_type ())
GType gimp_page_selector_target_get_type (void) G_GNUC_CONST;
@@ -102,6 +134,14 @@ typedef enum
} GimpPageSelectorTarget;
+/**
+ * GimpSizeEntryUpdatePolicy:
+ * @GIMP_SIZE_ENTRY_UPDATE_NONE: the size entry's meaning is up to the user
+ * @GIMP_SIZE_ENTRY_UPDATE_SIZE: the size entry displays values
+ * @GIMP_SIZE_ENTRY_UPDATE_RESOLUTION: the size entry displays resolutions
+ *
+ * Update policies for #GimpSizeEntry.
+ **/
#define GIMP_TYPE_SIZE_ENTRY_UPDATE_POLICY (gimp_size_entry_update_policy_get_type ())
GType gimp_size_entry_update_policy_get_type (void) G_GNUC_CONST;
@@ -114,6 +154,18 @@ typedef enum
} GimpSizeEntryUpdatePolicy;
+/**
+ * GimpZoomType:
+ * @GIMP_ZOOM_IN: zoom in
+ * @GIMP_ZOOM_OUT: zoom out
+ * @GIMP_ZOOM_IN_MORE: zoom in a lot
+ * @GIMP_ZOOM_OUT_MORE: zoom out a lot
+ * @GIMP_ZOOM_IN_MAX: zoom in as far as possible
+ * @GIMP_ZOOM_OUT_MAX: zoom out as far as possible
+ * @GIMP_ZOOM_TO: zoom to a specific zoom factor
+ *
+ * the zoom types for #GimpZoomModel.
+ **/
#define GIMP_TYPE_ZOOM_TYPE (gimp_zoom_type_get_type ())
GType gimp_zoom_type_get_type (void) G_GNUC_CONST;
diff --git a/libgimpwidgets/gimpzoommodel.c b/libgimpwidgets/gimpzoommodel.c
index 1dff08c..caa557d 100644
--- a/libgimpwidgets/gimpzoommodel.c
+++ b/libgimpwidgets/gimpzoommodel.c
@@ -578,7 +578,7 @@ gimp_zoom_button_new (GimpZoomModel *model,
/**
* gimp_zoom_model_zoom_step:
- * @zoom_type:
+ * @zoom_type: the zoom type
* @scale: ignored unless @zoom_type == %GIMP_ZOOM_TO
*
* Utility function to calculate a new scale factor.
[
Date Prev][
Date Next] [
Thread Prev][
Thread Next]
[
Thread Index]
[
Date Index]
[
Author Index]
