[gimp] libgimp: add blurbs to all object properties for the docs
- From: Michael Natterer <mitch src gnome org>
- To: commits-list gnome org
- Cc:
- Subject: [gimp] libgimp: add blurbs to all object properties for the docs
- Date: Tue, 6 Jun 2017 19:20:45 +0000 (UTC)
commit f9ee38ea332c3c77cde6d3b6808d3ad7df2ce55d
Author: Michael Natterer <mitch gimp org>
Date: Tue Jun 6 21:19:17 2017 +0200
libgimp: add blurbs to all object properties for the docs
and some minor doc fixes.
libgimp/gimpaspectpreview.c | 8 ++++-
libgimp/gimpdrawablepreview.c | 8 ++++-
libgimp/gimpzoompreview.c | 12 ++++++--
libgimpwidgets/gimpcellrenderercolor.c | 23 ++++++++++------
libgimpwidgets/gimpcellrenderertoggle.c | 14 ++++++---
libgimpwidgets/gimpchainbutton.c | 4 ++-
libgimpwidgets/gimpcolorarea.c | 17 ++++++++---
libgimpwidgets/gimpcolorbutton.c | 30 ++++++++++++++-------
libgimpwidgets/gimpcolordisplay.c | 12 ++++++--
libgimpwidgets/gimpcolorprofilecombobox.c | 8 ++++-
libgimpwidgets/gimpcolorprofilestore.c | 4 ++-
libgimpwidgets/gimpcolorscale.c | 4 ++-
libgimpwidgets/gimpcolorselection.c | 3 +-
libgimpwidgets/gimpcontroller.c | 8 ++++-
libgimpwidgets/gimpdialog.c | 12 ++++++--
libgimpwidgets/gimpenumcombobox.c | 4 ++-
libgimpwidgets/gimpenumlabel.c | 8 ++++-
libgimpwidgets/gimpenumstore.c | 3 +-
libgimpwidgets/gimpframe.c | 6 +++-
libgimpwidgets/gimphintbox.c | 14 ++++++++--
libgimpwidgets/gimpicons.c | 4 +-
libgimpwidgets/gimpintcombobox.c | 8 ++++-
libgimpwidgets/gimpintstore.c | 3 +-
libgimpwidgets/gimpnumberpairentry.c | 39 ++++++++++++++++++++--------
libgimpwidgets/gimppageselector.c | 8 ++++-
libgimpwidgets/gimppreview.c | 6 +++-
libgimpwidgets/gimppreviewarea.c | 6 +++-
libgimpwidgets/gimpruler.c | 3 +-
libgimpwidgets/gimpstringcombobox.c | 12 ++++++--
libgimpwidgets/gimpunitcombobox.c | 3 +-
libgimpwidgets/gimpunitstore.c | 15 +++++++---
libgimpwidgets/gimpzoommodel.c | 40 +++++++++++++++++++++++++---
32 files changed, 253 insertions(+), 96 deletions(-)
---
diff --git a/libgimp/gimpaspectpreview.c b/libgimp/gimpaspectpreview.c
index 225c087..f82815e 100644
--- a/libgimp/gimpaspectpreview.c
+++ b/libgimp/gimpaspectpreview.c
@@ -137,7 +137,9 @@ gimp_aspect_preview_class_init (GimpAspectPreviewClass *klass)
* Since: 2.4
*/
g_object_class_install_property (object_class, PROP_DRAWABLE,
- g_param_spec_pointer ("drawable", NULL, NULL,
+ g_param_spec_pointer ("drawable",
+ "Drawable",
+ "Deprecated: use the drawable-id property instead",
GIMP_PARAM_READWRITE |
G_PARAM_CONSTRUCT_ONLY));
@@ -149,7 +151,9 @@ gimp_aspect_preview_class_init (GimpAspectPreviewClass *klass)
* Since: 2.10
*/
g_object_class_install_property (object_class, PROP_DRAWABLE_ID,
- g_param_spec_int ("drawable-id", NULL, NULL,
+ g_param_spec_int ("drawable-id",
+ "Drawable ID",
+ "The drawable this preview is attached to",
-1, G_MAXINT, -1,
GIMP_PARAM_READWRITE |
G_PARAM_CONSTRUCT_ONLY));
diff --git a/libgimp/gimpdrawablepreview.c b/libgimp/gimpdrawablepreview.c
index e8b8de6..13fa4dc 100644
--- a/libgimp/gimpdrawablepreview.c
+++ b/libgimp/gimpdrawablepreview.c
@@ -137,7 +137,9 @@ gimp_drawable_preview_class_init (GimpDrawablePreviewClass *klass)
* Since: 2.4
*/
g_object_class_install_property (object_class, PROP_DRAWABLE,
- g_param_spec_pointer ("drawable", NULL, NULL,
+ g_param_spec_pointer ("drawable",
+ "Drawable",
+ "Deprecated: use the drawable-id property instead",
GIMP_PARAM_READWRITE |
G_PARAM_CONSTRUCT_ONLY));
@@ -149,7 +151,9 @@ gimp_drawable_preview_class_init (GimpDrawablePreviewClass *klass)
* Since: 2.10
*/
g_object_class_install_property (object_class, PROP_DRAWABLE_ID,
- g_param_spec_int ("drawable-id", NULL, NULL,
+ g_param_spec_int ("drawable-id",
+ "Drawable ID",
+ "The drawable this preview is attached to",
-1, G_MAXINT, -1,
GIMP_PARAM_READWRITE |
G_PARAM_CONSTRUCT_ONLY));
diff --git a/libgimp/gimpzoompreview.c b/libgimp/gimpzoompreview.c
index 95e84fa..56d0973 100644
--- a/libgimp/gimpzoompreview.c
+++ b/libgimp/gimpzoompreview.c
@@ -170,7 +170,9 @@ gimp_zoom_preview_class_init (GimpZoomPreviewClass *klass)
* Since: 2.4
*/
g_object_class_install_property (object_class, PROP_DRAWABLE,
- g_param_spec_pointer ("drawable", NULL, NULL,
+ g_param_spec_pointer ("drawable",
+ "Drawable",
+ "Deprecated: use the drawable-id property instead",
GIMP_PARAM_READWRITE |
G_PARAM_CONSTRUCT_ONLY));
@@ -182,7 +184,9 @@ gimp_zoom_preview_class_init (GimpZoomPreviewClass *klass)
* Since: 2.10
*/
g_object_class_install_property (object_class, PROP_DRAWABLE_ID,
- g_param_spec_int ("drawable-id", NULL, NULL,
+ g_param_spec_int ("drawable-id",
+ "Drawable ID",
+ "The drawable this preview is attached to",
-1, G_MAXINT, -1,
GIMP_PARAM_READWRITE |
G_PARAM_CONSTRUCT_ONLY));
@@ -195,7 +199,9 @@ gimp_zoom_preview_class_init (GimpZoomPreviewClass *klass)
* Since: 2.4
*/
g_object_class_install_property (object_class, PROP_MODEL,
- g_param_spec_object ("model", NULL, NULL,
+ g_param_spec_object ("model",
+ "Model",
+ "The zoom preview's GimpZoomModel",
GIMP_TYPE_ZOOM_MODEL,
GIMP_PARAM_READWRITE |
G_PARAM_CONSTRUCT_ONLY));
diff --git a/libgimpwidgets/gimpcellrenderercolor.c b/libgimpwidgets/gimpcellrenderercolor.c
index 95255bf..b667281 100644
--- a/libgimpwidgets/gimpcellrenderercolor.c
+++ b/libgimpwidgets/gimpcellrenderercolor.c
@@ -97,20 +97,25 @@ gimp_cell_renderer_color_class_init (GimpCellRendererColorClass *klass)
cell_class->get_size = gimp_cell_renderer_color_get_size;
cell_class->render = gimp_cell_renderer_color_render;
- g_object_class_install_property (object_class,
- PROP_COLOR,
- g_param_spec_boxed ("color", NULL, NULL,
+ g_object_class_install_property (object_class, PROP_COLOR,
+ g_param_spec_boxed ("color",
+ "Color",
+ "The displayed color",
GIMP_TYPE_RGB,
GIMP_PARAM_READWRITE));
- g_object_class_install_property (object_class,
- PROP_OPAQUE,
- g_param_spec_boolean ("opaque", NULL, NULL,
+
+ g_object_class_install_property (object_class, PROP_OPAQUE,
+ g_param_spec_boolean ("opaque",
+ "Opaque",
+ "Whether to show transparency",
TRUE,
GIMP_PARAM_READWRITE |
G_PARAM_CONSTRUCT));
- g_object_class_install_property (object_class,
- PROP_SIZE,
- g_param_spec_int ("icon-size", NULL, NULL,
+
+ g_object_class_install_property (object_class, PROP_SIZE,
+ g_param_spec_int ("icon-size",
+ "Icon Size",
+ "The cell's size",
0, G_MAXINT,
DEFAULT_ICON_SIZE,
GIMP_PARAM_READWRITE |
diff --git a/libgimpwidgets/gimpcellrenderertoggle.c b/libgimpwidgets/gimpcellrenderertoggle.c
index dcc4bc0..1b59155 100644
--- a/libgimpwidgets/gimpcellrenderertoggle.c
+++ b/libgimpwidgets/gimpcellrenderertoggle.c
@@ -141,21 +141,24 @@ gimp_cell_renderer_toggle_class_init (GimpCellRendererToggleClass *klass)
g_object_class_install_property (object_class, PROP_ICON_NAME,
g_param_spec_string ("icon-name",
- NULL, NULL,
+ "Icon Name",
+ "The icon to display",
NULL,
GIMP_PARAM_READWRITE |
G_PARAM_CONSTRUCT));
g_object_class_install_property (object_class, PROP_STOCK_ID,
g_param_spec_string ("stock-id",
- NULL, NULL,
+ "Stock ID",
+ "The icon to display, deprecated",
NULL,
GIMP_PARAM_READWRITE |
G_PARAM_CONSTRUCT));
g_object_class_install_property (object_class, PROP_STOCK_SIZE,
g_param_spec_int ("stock-size",
- NULL, NULL,
+ "Stock Size",
+ "The icon size to use",
0, G_MAXINT,
DEFAULT_ICON_SIZE,
GIMP_PARAM_READWRITE |
@@ -163,7 +166,8 @@ gimp_cell_renderer_toggle_class_init (GimpCellRendererToggleClass *klass)
g_object_class_install_property (object_class, PROP_OVERRIDE_BACKGROUND,
g_param_spec_boolean ("override-background",
- NULL, NULL,
+ "Override Background",
+ "Draw the background if the row is selected",
FALSE,
GIMP_PARAM_READWRITE |
G_PARAM_CONSTRUCT));
@@ -376,7 +380,7 @@ gimp_cell_renderer_toggle_render (GtkCellRenderer *cell,
return;
}
- if (flags & GTK_CELL_RENDERER_SELECTED &&
+ if ((flags & GTK_CELL_RENDERER_SELECTED) &&
priv->override_background)
{
gboolean background_set;
diff --git a/libgimpwidgets/gimpchainbutton.c b/libgimpwidgets/gimpchainbutton.c
index 3e884c6..054a1bd 100644
--- a/libgimpwidgets/gimpchainbutton.c
+++ b/libgimpwidgets/gimpchainbutton.c
@@ -124,7 +124,9 @@ gimp_chain_button_class_init (GimpChainButtonClass *klass)
* Since: 2.4
*/
g_object_class_install_property (object_class, PROP_POSITION,
- g_param_spec_enum ("position", NULL, NULL,
+ g_param_spec_enum ("position",
+ "Position",
+ "The chain's position",
GIMP_TYPE_CHAIN_POSITION,
GIMP_CHAIN_TOP,
G_PARAM_CONSTRUCT_ONLY |
diff --git a/libgimpwidgets/gimpcolorarea.c b/libgimpwidgets/gimpcolorarea.c
index 63fd8f8..df44e8f 100644
--- a/libgimpwidgets/gimpcolorarea.c
+++ b/libgimpwidgets/gimpcolorarea.c
@@ -178,7 +178,9 @@ gimp_color_area_class_init (GimpColorAreaClass *klass)
* Since: 2.4
*/
g_object_class_install_property (object_class, PROP_COLOR,
- gimp_param_spec_rgb ("color", NULL, NULL,
+ gimp_param_spec_rgb ("color",
+ "Color",
+ "The displayed color",
TRUE, &color,
GIMP_PARAM_READWRITE |
G_PARAM_CONSTRUCT));
@@ -190,7 +192,9 @@ gimp_color_area_class_init (GimpColorAreaClass *klass)
* Since: 2.4
*/
g_object_class_install_property (object_class, PROP_TYPE,
- g_param_spec_enum ("type", NULL, NULL,
+ g_param_spec_enum ("type",
+ "Type",
+ "The type of the color area",
GIMP_TYPE_COLOR_AREA_TYPE,
GIMP_COLOR_AREA_FLAT,
GIMP_PARAM_READWRITE |
@@ -198,12 +202,14 @@ gimp_color_area_class_init (GimpColorAreaClass *klass)
/**
* GimpColorArea:drag-type:
*
- * The event_mask that should trigger drags.
+ * The modifier mask that should trigger drags.
*
* Since: 2.4
*/
g_object_class_install_property (object_class, PROP_DRAG_MASK,
- g_param_spec_flags ("drag-mask", NULL, NULL,
+ g_param_spec_flags ("drag-mask",
+ "Drag Mask",
+ "The modifier mask that triggers dragging the color",
GDK_TYPE_MODIFIER_TYPE,
0,
GIMP_PARAM_WRITABLE |
@@ -217,7 +223,8 @@ gimp_color_area_class_init (GimpColorAreaClass *klass)
*/
g_object_class_install_property (object_class, PROP_DRAW_BORDER,
g_param_spec_boolean ("draw-border",
- NULL, NULL,
+ "Draw Border",
+ "Whether to draw a thin border in the foreground
color around the area",
FALSE,
GIMP_PARAM_READWRITE));
diff --git a/libgimpwidgets/gimpcolorbutton.c b/libgimpwidgets/gimpcolorbutton.c
index c9f56c8..2ce54b4 100644
--- a/libgimpwidgets/gimpcolorbutton.c
+++ b/libgimpwidgets/gimpcolorbutton.c
@@ -241,7 +241,9 @@ gimp_color_button_class_init (GimpColorButtonClass *klass)
* Since: 2.4
*/
g_object_class_install_property (object_class, PROP_TITLE,
- g_param_spec_string ("title", NULL, NULL,
+ g_param_spec_string ("title",
+ "Title",
+ "The title to be used for the color selection
dialog",
NULL,
GIMP_PARAM_READWRITE |
G_PARAM_CONSTRUCT));
@@ -253,7 +255,9 @@ gimp_color_button_class_init (GimpColorButtonClass *klass)
* Since: 2.4
*/
g_object_class_install_property (object_class, PROP_COLOR,
- gimp_param_spec_rgb ("color", NULL, NULL,
+ gimp_param_spec_rgb ("color",
+ "Color",
+ "The color displayed in the button's color area",
TRUE, &color,
GIMP_PARAM_READWRITE |
G_PARAM_CONSTRUCT));
@@ -265,7 +269,9 @@ gimp_color_button_class_init (GimpColorButtonClass *klass)
* Since: 2.4
*/
g_object_class_install_property (object_class, PROP_TYPE,
- g_param_spec_enum ("type", NULL, NULL,
+ g_param_spec_enum ("type",
+ "Type",
+ "The type of the button's color area",
GIMP_TYPE_COLOR_AREA_TYPE,
GIMP_COLOR_AREA_FLAT,
GIMP_PARAM_READWRITE |
@@ -279,7 +285,8 @@ gimp_color_button_class_init (GimpColorButtonClass *klass)
*/
g_object_class_install_property (object_class, PROP_UPDATE,
g_param_spec_boolean ("continuous-update",
- NULL, NULL,
+ "Contiguous Update",
+ "The update policy of the color button",
FALSE,
G_PARAM_READWRITE |
G_PARAM_CONSTRUCT));
@@ -292,7 +299,8 @@ gimp_color_button_class_init (GimpColorButtonClass *klass)
*/
g_object_class_install_property (object_class, PROP_AREA_WIDTH,
g_param_spec_int ("area-width",
- NULL, NULL,
+ "Area Width",
+ "The minimum width of the button's GimpColorArea",
1, G_MAXINT, 16,
G_PARAM_WRITABLE |
G_PARAM_CONSTRUCT));
@@ -305,7 +313,8 @@ gimp_color_button_class_init (GimpColorButtonClass *klass)
*/
g_object_class_install_property (object_class, PROP_AREA_HEIGHT,
g_param_spec_int ("area-height",
- NULL, NULL,
+ "Area Height",
+ "The minimum height of the button's GimpColorArea",
1, G_MAXINT, 16,
G_PARAM_WRITABLE |
G_PARAM_CONSTRUCT));
@@ -319,7 +328,8 @@ gimp_color_button_class_init (GimpColorButtonClass *klass)
*/
g_object_class_install_property (object_class, PROP_COLOR_CONFIG,
g_param_spec_object ("color-config",
- NULL, NULL,
+ "Color Config",
+ "The color config object used",
GIMP_TYPE_COLOR_CONFIG,
G_PARAM_READWRITE));
@@ -681,7 +691,7 @@ gimp_color_button_new (const gchar *title,
*
* Sets the @button dialog's title.
*
- * Since: GIMP 2.10
+ * Since: 2.10
**/
void
gimp_color_button_set_title (GimpColorButton *button,
@@ -705,7 +715,7 @@ gimp_color_button_set_title (GimpColorButton *button,
*
* Returns: The @button dialog's title.
*
- * Since: GIMP 2.10
+ * Since: 2.10
**/
const gchar *
gimp_color_button_get_title (GimpColorButton *button)
@@ -894,7 +904,7 @@ gimp_color_button_set_color_config (GimpColorButton *button,
*
* Returns: The @button's #GtkUIManager.
*
- * Since: GIMP 2.10
+ * Since: 2.10
**/
GtkUIManager *
gimp_color_button_get_ui_manager (GimpColorButton *button)
diff --git a/libgimpwidgets/gimpcolordisplay.c b/libgimpwidgets/gimpcolordisplay.c
index 546fcbd..49ed918 100644
--- a/libgimpwidgets/gimpcolordisplay.c
+++ b/libgimpwidgets/gimpcolordisplay.c
@@ -109,19 +109,25 @@ gimp_color_display_class_init (GimpColorDisplayClass *klass)
g_type_class_add_private (object_class, sizeof (GimpColorDisplayPrivate));
g_object_class_install_property (object_class, PROP_ENABLED,
- g_param_spec_boolean ("enabled", NULL, NULL,
+ g_param_spec_boolean ("enabled",
+ "Enabled",
+ "Whether this display filter is enabled",
TRUE,
GIMP_PARAM_READWRITE |
G_PARAM_CONSTRUCT));
+
g_object_class_install_property (object_class, PROP_COLOR_CONFIG,
g_param_spec_object ("color-config",
- NULL, NULL,
+ "Color Config",
+ "The color config used for this filter",
GIMP_TYPE_COLOR_CONFIG,
GIMP_PARAM_READWRITE |
G_PARAM_CONSTRUCT_ONLY));
+
g_object_class_install_property (object_class, PROP_COLOR_MANAGED,
g_param_spec_object ("color-managed",
- NULL, NULL,
+ "Color Managed",
+ "The color managed pixel source that is filtered",
GIMP_TYPE_COLOR_MANAGED,
GIMP_PARAM_READWRITE |
G_PARAM_CONSTRUCT_ONLY));
diff --git a/libgimpwidgets/gimpcolorprofilecombobox.c b/libgimpwidgets/gimpcolorprofilecombobox.c
index 7dda409..28e8cd8 100644
--- a/libgimpwidgets/gimpcolorprofilecombobox.c
+++ b/libgimpwidgets/gimpcolorprofilecombobox.c
@@ -110,7 +110,9 @@ gimp_color_profile_combo_box_class_init (GimpColorProfileComboBoxClass *klass)
*/
g_object_class_install_property (object_class,
PROP_DIALOG,
- g_param_spec_object ("dialog", NULL, NULL,
+ g_param_spec_object ("dialog",
+ "Dialog",
+ "The dialog to present when selecting profiles from
disk",
GTK_TYPE_DIALOG,
G_PARAM_CONSTRUCT_ONLY |
GIMP_PARAM_READWRITE));
@@ -125,7 +127,9 @@ gimp_color_profile_combo_box_class_init (GimpColorProfileComboBoxClass *klass)
*/
g_object_class_install_property (object_class,
PROP_MODEL,
- g_param_spec_object ("model", NULL, NULL,
+ g_param_spec_object ("model",
+ "Model",
+ "The profile store used for this combo box",
GIMP_TYPE_COLOR_PROFILE_STORE,
GIMP_PARAM_READWRITE));
diff --git a/libgimpwidgets/gimpcolorprofilestore.c b/libgimpwidgets/gimpcolorprofilestore.c
index 62f8636..267694c 100644
--- a/libgimpwidgets/gimpcolorprofilestore.c
+++ b/libgimpwidgets/gimpcolorprofilestore.c
@@ -108,7 +108,9 @@ gimp_color_profile_store_class_init (GimpColorProfileStoreClass *klass)
*/
g_object_class_install_property (object_class,
PROP_HISTORY,
- g_param_spec_string ("history", NULL, NULL,
+ g_param_spec_string ("history",
+ "History",
+ "Filename of the color history used to populate the
profile store",
NULL,
G_PARAM_CONSTRUCT_ONLY |
GIMP_PARAM_READWRITE));
diff --git a/libgimpwidgets/gimpcolorscale.c b/libgimpwidgets/gimpcolorscale.c
index a0b6fa1..e9ad36a 100644
--- a/libgimpwidgets/gimpcolorscale.c
+++ b/libgimpwidgets/gimpcolorscale.c
@@ -146,7 +146,9 @@ gimp_color_scale_class_init (GimpColorScaleClass *klass)
* Since: 2.8
*/
g_object_class_install_property (object_class, PROP_CHANNEL,
- g_param_spec_enum ("channel", NULL, NULL,
+ g_param_spec_enum ("channel",
+ "Channel",
+ "The channel which is edited by the color scale",
GIMP_TYPE_COLOR_SELECTOR_CHANNEL,
GIMP_COLOR_SELECTOR_VALUE,
GIMP_PARAM_READWRITE |
diff --git a/libgimpwidgets/gimpcolorselection.c b/libgimpwidgets/gimpcolorselection.c
index 5c3eab5..c190b73 100644
--- a/libgimpwidgets/gimpcolorselection.c
+++ b/libgimpwidgets/gimpcolorselection.c
@@ -132,7 +132,8 @@ gimp_color_selection_class_init (GimpColorSelectionClass *klass)
g_object_class_install_property (object_class, PROP_CONFIG,
g_param_spec_object ("config",
- NULL, NULL,
+ "Config",
+ "The color config used by this color selection",
GIMP_TYPE_COLOR_CONFIG,
G_PARAM_WRITABLE));
diff --git a/libgimpwidgets/gimpcontroller.c b/libgimpwidgets/gimpcontroller.c
index 89d683a..2da5fb5 100644
--- a/libgimpwidgets/gimpcontroller.c
+++ b/libgimpwidgets/gimpcontroller.c
@@ -97,13 +97,17 @@ gimp_controller_class_init (GimpControllerClass *klass)
klass->event = NULL;
g_object_class_install_property (object_class, PROP_NAME,
- g_param_spec_string ("name", NULL, NULL,
+ g_param_spec_string ("name",
+ "Name",
+ "The controller's name",
"Unnamed Controller",
GIMP_PARAM_READWRITE |
G_PARAM_CONSTRUCT));
g_object_class_install_property (object_class, PROP_STATE,
- g_param_spec_string ("state", NULL, NULL,
+ g_param_spec_string ("state",
+ "State",
+ "The controller's state, as human-readable string",
"Unknown",
GIMP_PARAM_READWRITE |
G_PARAM_CONSTRUCT));
diff --git a/libgimpwidgets/gimpdialog.c b/libgimpwidgets/gimpdialog.c
index d31deb3..789bcb7 100644
--- a/libgimpwidgets/gimpdialog.c
+++ b/libgimpwidgets/gimpdialog.c
@@ -119,7 +119,9 @@ gimp_dialog_class_init (GimpDialogClass *klass)
* Since: 2.2
**/
g_object_class_install_property (object_class, PROP_HELP_FUNC,
- g_param_spec_pointer ("help-func", NULL, NULL,
+ g_param_spec_pointer ("help-func",
+ "Help Func",
+ "The help function to call when F1 is hit",
GIMP_PARAM_READWRITE |
G_PARAM_CONSTRUCT_ONLY));
@@ -129,7 +131,9 @@ gimp_dialog_class_init (GimpDialogClass *klass)
* Since: 2.2
**/
g_object_class_install_property (object_class, PROP_HELP_ID,
- g_param_spec_string ("help-id", NULL, NULL,
+ g_param_spec_string ("help-id",
+ "Help ID",
+ "The help ID to pass to help-func",
NULL,
GIMP_PARAM_READWRITE |
G_PARAM_CONSTRUCT));
@@ -140,7 +144,9 @@ gimp_dialog_class_init (GimpDialogClass *klass)
* Since: 2.8
**/
g_object_class_install_property (object_class, PROP_PARENT,
- g_param_spec_object ("parent", NULL, NULL,
+ g_param_spec_object ("parent",
+ "Parent",
+ "The dialog's parent widget",
GTK_TYPE_WIDGET,
GIMP_PARAM_WRITABLE |
G_PARAM_CONSTRUCT_ONLY));
diff --git a/libgimpwidgets/gimpenumcombobox.c b/libgimpwidgets/gimpenumcombobox.c
index 58ef910..209e6f8 100644
--- a/libgimpwidgets/gimpenumcombobox.c
+++ b/libgimpwidgets/gimpenumcombobox.c
@@ -74,7 +74,9 @@ gimp_enum_combo_box_class_init (GimpEnumComboBoxClass *klass)
/* override the "model" property of GtkComboBox */
g_object_class_install_property (object_class,
PROP_MODEL,
- g_param_spec_object ("model", NULL, NULL,
+ g_param_spec_object ("model",
+ "Model",
+ "The enum store used by this combo box",
GIMP_TYPE_ENUM_STORE,
GIMP_PARAM_READWRITE));
}
diff --git a/libgimpwidgets/gimpenumlabel.c b/libgimpwidgets/gimpenumlabel.c
index bb6c1bd..0045984 100644
--- a/libgimpwidgets/gimpenumlabel.c
+++ b/libgimpwidgets/gimpenumlabel.c
@@ -80,7 +80,9 @@ gimp_enum_label_class_init (GimpEnumLabelClass *klass)
* Since: 2.8
**/
g_object_class_install_property (object_class, PROP_ENUM_TYPE,
- g_param_spec_gtype ("enum-type", NULL, NULL,
+ g_param_spec_gtype ("enum-type",
+ "Enum Type",
+ "The type of the displayed enum",
G_TYPE_NONE,
GIMP_PARAM_READWRITE |
G_PARAM_CONSTRUCT_ONLY));
@@ -93,7 +95,9 @@ gimp_enum_label_class_init (GimpEnumLabelClass *klass)
* Since: 2.8
**/
g_object_class_install_property (object_class, PROP_ENUM_VALUE,
- g_param_spec_int ("enum-value", NULL, NULL,
+ g_param_spec_int ("enum-value",
+ "Enum Value",
+ "The enum value to display",
G_MININT, G_MAXINT, 0,
GIMP_PARAM_WRITABLE |
G_PARAM_CONSTRUCT));
diff --git a/libgimpwidgets/gimpenumstore.c b/libgimpwidgets/gimpenumstore.c
index 3f5e359..a20418a 100644
--- a/libgimpwidgets/gimpenumstore.c
+++ b/libgimpwidgets/gimpenumstore.c
@@ -84,7 +84,8 @@ gimp_enum_store_class_init (GimpEnumStoreClass *klass)
g_object_class_install_property (object_class,
PROP_ENUM_TYPE,
g_param_spec_gtype ("enum-type",
- NULL, NULL,
+ "Enum Type",
+ "The type of the enum",
G_TYPE_ENUM,
G_PARAM_CONSTRUCT_ONLY |
GIMP_PARAM_READWRITE));
diff --git a/libgimpwidgets/gimpframe.c b/libgimpwidgets/gimpframe.c
index 4ab7229..3ea630f 100644
--- a/libgimpwidgets/gimpframe.c
+++ b/libgimpwidgets/gimpframe.c
@@ -80,12 +80,14 @@ gimp_frame_class_init (GimpFrameClass *klass)
gtk_widget_class_install_style_property (widget_class,
g_param_spec_boolean ("label-bold",
- NULL, NULL,
+ "Label Bold",
+ "Whether the frame's label should be bold",
DEFAULT_LABEL_BOLD,
G_PARAM_READABLE));
gtk_widget_class_install_style_property (widget_class,
g_param_spec_int ("label-spacing",
- NULL, NULL,
+ "Label Spacing",
+ "The spacing between the label and the frame
content",
0,
G_MAXINT,
DEFAULT_LABEL_SPACING,
diff --git a/libgimpwidgets/gimphintbox.c b/libgimpwidgets/gimphintbox.c
index eac09e3..85cbf1c 100644
--- a/libgimpwidgets/gimphintbox.c
+++ b/libgimpwidgets/gimphintbox.c
@@ -87,17 +87,25 @@ gimp_hint_box_class_init (GimpHintBoxClass *klass)
object_class->get_property = gimp_hint_box_get_property;
g_object_class_install_property (object_class, PROP_ICON_NAME,
- g_param_spec_string ("icon-name", NULL, NULL,
+ g_param_spec_string ("icon-name",
+ "Icon Name",
+ "The icon to show next to the hint",
GIMP_ICON_DIALOG_INFORMATION,
G_PARAM_CONSTRUCT_ONLY |
GIMP_PARAM_READWRITE));
+
g_object_class_install_property (object_class, PROP_STOCK_ID,
- g_param_spec_string ("stock-id", NULL, NULL,
+ g_param_spec_string ("stock-id",
+ "Stock ID",
+ "Deprecated: use icon-name instead",
GIMP_ICON_DIALOG_INFORMATION,
G_PARAM_CONSTRUCT_ONLY |
GIMP_PARAM_READWRITE));
+
g_object_class_install_property (object_class, PROP_HINT,
- g_param_spec_string ("hint", NULL, NULL,
+ g_param_spec_string ("hint",
+ "Hint",
+ "The hint to display",
NULL,
G_PARAM_CONSTRUCT_ONLY |
GIMP_PARAM_READWRITE));
diff --git a/libgimpwidgets/gimpicons.c b/libgimpwidgets/gimpicons.c
index 12f85ca..1a6f842 100644
--- a/libgimpwidgets/gimpicons.c
+++ b/libgimpwidgets/gimpicons.c
@@ -34,8 +34,8 @@
/**
- * SECTION: gimpstock
- * @title: GimpStock
+ * SECTION: gimpicons
+ * @title: GimpIcons
* @short_description: Prebuilt common menu/toolbar items and
* corresponding icons
*
diff --git a/libgimpwidgets/gimpintcombobox.c b/libgimpwidgets/gimpintcombobox.c
index a270dcd..e427295 100644
--- a/libgimpwidgets/gimpintcombobox.c
+++ b/libgimpwidgets/gimpintcombobox.c
@@ -109,7 +109,9 @@ gimp_int_combo_box_class_init (GimpIntComboBoxClass *klass)
* Since: 2.4
*/
g_object_class_install_property (object_class, PROP_ELLIPSIZE,
- g_param_spec_enum ("ellipsize", NULL, NULL,
+ g_param_spec_enum ("ellipsize",
+ "Ellipsize",
+ "Ellipsize mode for the used text cell renderer",
PANGO_TYPE_ELLIPSIZE_MODE,
PANGO_ELLIPSIZE_NONE,
GIMP_PARAM_READWRITE));
@@ -122,7 +124,9 @@ gimp_int_combo_box_class_init (GimpIntComboBoxClass *klass)
* Since: 2.10
*/
g_object_class_install_property (object_class, PROP_LABEL,
- g_param_spec_string ("label", NULL, NULL,
+ g_param_spec_string ("label",
+ "Label",
+ "An optional label to be displayed",
NULL,
GIMP_PARAM_READWRITE));
diff --git a/libgimpwidgets/gimpintstore.c b/libgimpwidgets/gimpintstore.c
index dc74ac2..d790be2 100644
--- a/libgimpwidgets/gimpintstore.c
+++ b/libgimpwidgets/gimpintstore.c
@@ -111,7 +111,8 @@ gimp_int_store_class_init (GimpIntStoreClass *klass)
g_object_class_install_property (object_class,
PROP_USER_DATA_TYPE,
g_param_spec_gtype ("user-data-type",
- NULL, NULL,
+ "User Data Type",
+ "The GType of the user_data column",
G_TYPE_NONE,
G_PARAM_CONSTRUCT_ONLY |
GIMP_PARAM_READWRITE));
diff --git a/libgimpwidgets/gimpnumberpairentry.c b/libgimpwidgets/gimpnumberpairentry.c
index 34adaa1..a89ffd7 100644
--- a/libgimpwidgets/gimpnumberpairentry.c
+++ b/libgimpwidgets/gimpnumberpairentry.c
@@ -178,8 +178,6 @@ gimp_number_pair_entry_class_init (GimpNumberPairEntryClass *klass)
{
GObjectClass *object_class = G_OBJECT_CLASS (klass);
- g_type_class_add_private (klass, sizeof (GimpNumberPairEntryPrivate));
-
entry_signals[NUMBERS_CHANGED] =
g_signal_new ("numbers-changed",
G_TYPE_FROM_CLASS (klass),
@@ -198,43 +196,52 @@ gimp_number_pair_entry_class_init (GimpNumberPairEntryClass *klass)
g_cclosure_marshal_VOID__VOID,
G_TYPE_NONE, 0);
- klass->numbers_changed = NULL;
- klass->ratio_changed = NULL;
-
object_class->set_property = gimp_number_pair_entry_set_property;
object_class->get_property = gimp_number_pair_entry_get_property;
object_class->finalize = gimp_number_pair_entry_finalize;
+ klass->numbers_changed = NULL;
+ klass->ratio_changed = NULL;
+
g_object_class_install_property (object_class, PROP_LEFT_NUMBER,
g_param_spec_double ("left-number",
- "Left number", NULL,
+ "Left number",
+ "The left number",
G_MINDOUBLE, G_MAXDOUBLE,
100.0,
GIMP_PARAM_READWRITE));
+
g_object_class_install_property (object_class, PROP_RIGHT_NUMBER,
g_param_spec_double ("right-number",
- "Right number", NULL,
+ "Right number",
+ "The right number",
G_MINDOUBLE, G_MAXDOUBLE,
100.0,
GIMP_PARAM_READWRITE));
+
g_object_class_install_property (object_class, PROP_DEFAULT_LEFT_NUMBER,
g_param_spec_double ("default-left-number",
- "Default left number", NULL,
+ "Default left number",
+ "The default left number",
G_MINDOUBLE, G_MAXDOUBLE,
100.0,
GIMP_PARAM_READWRITE));
+
g_object_class_install_property (object_class, PROP_DEFAULT_RIGHT_NUMBER,
g_param_spec_double ("default-right-number",
- "Default right number", NULL,
+ "Default right number",
+ "The default right number",
G_MINDOUBLE, G_MAXDOUBLE,
100.0,
GIMP_PARAM_READWRITE));
+
g_object_class_install_property (object_class, PROP_USER_OVERRIDE,
g_param_spec_boolean ("user-override",
"User override",
"Whether the widget is in 'user override' mode",
FALSE,
GIMP_PARAM_READWRITE));
+
g_object_class_install_property (object_class, PROP_SEPARATORS,
g_param_spec_string ("separators",
"Separators",
@@ -242,18 +249,21 @@ gimp_number_pair_entry_class_init (GimpNumberPairEntryClass *klass)
NULL,
GIMP_PARAM_READWRITE |
G_PARAM_CONSTRUCT_ONLY));
+
g_object_class_install_property (object_class, PROP_DEFAULT_TEXT,
g_param_spec_string ("default-text",
"Default text",
"String to show when in automatic mode",
NULL,
GIMP_PARAM_READWRITE));
+
g_object_class_install_property (object_class, PROP_ALLOW_SIMPLIFICATION,
g_param_spec_boolean ("allow-simplification",
"Allow simplification",
"Whether to allow simplification",
FALSE,
GIMP_PARAM_READWRITE));
+
g_object_class_install_property (object_class, PROP_MIN_VALID_VALUE,
g_param_spec_double ("min-valid-value",
"Min valid value",
@@ -261,6 +271,7 @@ gimp_number_pair_entry_class_init (GimpNumberPairEntryClass *klass)
G_MINDOUBLE, G_MAXDOUBLE,
G_MINDOUBLE,
GIMP_PARAM_READWRITE));
+
g_object_class_install_property (object_class, PROP_MAX_VALID_VALUE,
g_param_spec_double ("max-valid-value",
"Max valid value",
@@ -268,18 +279,24 @@ gimp_number_pair_entry_class_init (GimpNumberPairEntryClass *klass)
G_MINDOUBLE, G_MAXDOUBLE,
G_MAXDOUBLE,
GIMP_PARAM_READWRITE));
+
g_object_class_install_property (object_class, PROP_RATIO,
g_param_spec_double ("ratio",
- "Ratio", NULL,
+ "Ratio",
+ "The value as ratio",
G_MINDOUBLE, G_MAXDOUBLE,
1.0,
GIMP_PARAM_READWRITE));
+
g_object_class_install_property (object_class, PROP_ASPECT,
g_param_spec_enum ("aspect",
- "Aspect", NULL,
+ "Aspect",
+ "The value as aspect",
GIMP_TYPE_ASPECT_TYPE,
GIMP_ASPECT_SQUARE,
GIMP_PARAM_READWRITE));
+
+ g_type_class_add_private (klass, sizeof (GimpNumberPairEntryPrivate));
}
static void
diff --git a/libgimpwidgets/gimppageselector.c b/libgimpwidgets/gimppageselector.c
index ea96995..4c7f82c 100644
--- a/libgimpwidgets/gimppageselector.c
+++ b/libgimpwidgets/gimppageselector.c
@@ -183,7 +183,9 @@ gimp_page_selector_class_init (GimpPageSelectorClass *klass)
* Since: 2.4
**/
g_object_class_install_property (object_class, PROP_N_PAGES,
- g_param_spec_int ("n-pages", NULL, NULL,
+ g_param_spec_int ("n-pages",
+ "N Pages",
+ "The number of pages to open",
0, G_MAXINT, 0,
GIMP_PARAM_READWRITE));
@@ -195,7 +197,9 @@ gimp_page_selector_class_init (GimpPageSelectorClass *klass)
* Since: 2.4
**/
g_object_class_install_property (object_class, PROP_TARGET,
- g_param_spec_enum ("target", NULL, NULL,
+ g_param_spec_enum ("target",
+ "Target",
+ "the target to open to",
GIMP_TYPE_PAGE_SELECTOR_TARGET,
GIMP_PAGE_SELECTOR_TARGET_LAYERS,
GIMP_PARAM_READWRITE));
diff --git a/libgimpwidgets/gimppreview.c b/libgimpwidgets/gimppreview.c
index 94b423f..bbd0a8f 100644
--- a/libgimpwidgets/gimppreview.c
+++ b/libgimpwidgets/gimppreview.c
@@ -184,14 +184,16 @@ gimp_preview_class_init (GimpPreviewClass *klass)
g_object_class_install_property (object_class,
PROP_UPDATE,
g_param_spec_boolean ("update",
- NULL, NULL,
+ "Update",
+ "Whether the preview should update automatically",
TRUE,
GIMP_PARAM_READWRITE |
G_PARAM_CONSTRUCT));
gtk_widget_class_install_style_property (widget_class,
g_param_spec_int ("size",
- NULL, NULL,
+ "Size",
+ "The preview's size",
1, 1024,
DEFAULT_SIZE,
GIMP_PARAM_READABLE));
diff --git a/libgimpwidgets/gimppreviewarea.c b/libgimpwidgets/gimppreviewarea.c
index 02b6fd3..990c69c 100644
--- a/libgimpwidgets/gimppreviewarea.c
+++ b/libgimpwidgets/gimppreviewarea.c
@@ -123,14 +123,16 @@ gimp_preview_area_class_init (GimpPreviewAreaClass *klass)
g_object_class_install_property (object_class, PROP_CHECK_SIZE,
g_param_spec_enum ("check-size",
- _("Check Size"), NULL,
+ _("Check Size"),
+ "The size of the checkerboard pattern indicating
transparency",
GIMP_TYPE_CHECK_SIZE,
DEFAULT_CHECK_SIZE,
GIMP_PARAM_READWRITE));
g_object_class_install_property (object_class, PROP_CHECK_TYPE,
g_param_spec_enum ("check-type",
- _("Check Style"), NULL,
+ _("Check Style"),
+ "The colors of the checkerboard pattern indicating
transparency",
GIMP_TYPE_CHECK_TYPE,
DEFAULT_CHECK_TYPE,
GIMP_PARAM_READWRITE));
diff --git a/libgimpwidgets/gimpruler.c b/libgimpwidgets/gimpruler.c
index 6b554c3..3766bd7 100644
--- a/libgimpwidgets/gimpruler.c
+++ b/libgimpwidgets/gimpruler.c
@@ -219,7 +219,8 @@ gimp_ruler_class_init (GimpRulerClass *klass)
gtk_widget_class_install_style_property (widget_class,
g_param_spec_double ("font-scale",
- NULL, NULL,
+ "Font Scale",
+ "The size of the used font",
0.0,
G_MAXDOUBLE,
DEFAULT_RULER_FONT_SCALE,
diff --git a/libgimpwidgets/gimpstringcombobox.c b/libgimpwidgets/gimpstringcombobox.c
index 172983d..4d1f13c 100644
--- a/libgimpwidgets/gimpstringcombobox.c
+++ b/libgimpwidgets/gimpstringcombobox.c
@@ -94,7 +94,9 @@ gimp_string_combo_box_class_init (GimpStringComboBoxClass *klass)
*/
g_object_class_install_property (object_class,
PROP_ID_COLUMN,
- g_param_spec_int ("id-column", NULL, NULL,
+ g_param_spec_int ("id-column",
+ "ID Column",
+ "The model column that holds the ID",
0, G_MAXINT,
0,
GIMP_PARAM_READWRITE |
@@ -109,7 +111,9 @@ gimp_string_combo_box_class_init (GimpStringComboBoxClass *klass)
*/
g_object_class_install_property (object_class,
PROP_LABEL_COLUMN,
- g_param_spec_int ("label-column", NULL, NULL,
+ g_param_spec_int ("label-column",
+ "Label Column",
+ "The model column that holds the label",
0, G_MAXINT,
0,
GIMP_PARAM_READWRITE |
@@ -126,7 +130,9 @@ gimp_string_combo_box_class_init (GimpStringComboBoxClass *klass)
*/
g_object_class_install_property (object_class,
PROP_ELLIPSIZE,
- g_param_spec_enum ("ellipsize", NULL, NULL,
+ g_param_spec_enum ("ellipsize",
+ "Ellipsize",
+ "Ellipsize mode for the text cell renderer",
PANGO_TYPE_ELLIPSIZE_MODE,
PANGO_ELLIPSIZE_NONE,
GIMP_PARAM_READWRITE));
diff --git a/libgimpwidgets/gimpunitcombobox.c b/libgimpwidgets/gimpunitcombobox.c
index d7038d5..af0929d 100644
--- a/libgimpwidgets/gimpunitcombobox.c
+++ b/libgimpwidgets/gimpunitcombobox.c
@@ -60,7 +60,8 @@ gimp_unit_combo_box_class_init (GimpUnitComboBoxClass *klass)
gtk_widget_class_install_style_property (widget_class,
g_param_spec_double ("label-scale",
- NULL, NULL,
+ "Label Scale",
+ "The scale for the text cell renderer",
0.0,
G_MAXDOUBLE,
1.0,
diff --git a/libgimpwidgets/gimpunitstore.c b/libgimpwidgets/gimpunitstore.c
index 6e43ef0..bf75814 100644
--- a/libgimpwidgets/gimpunitstore.c
+++ b/libgimpwidgets/gimpunitstore.c
@@ -138,32 +138,37 @@ gimp_unit_store_class_init (GimpUnitStoreClass *klass)
g_object_class_install_property (object_class, PROP_NUM_VALUES,
g_param_spec_int ("num-values",
- NULL, NULL,
+ "Num Values",
+ "The number of values this store provides",
0, G_MAXINT, 0,
GIMP_PARAM_READWRITE |
G_PARAM_CONSTRUCT_ONLY));
g_object_class_install_property (object_class, PROP_HAS_PIXELS,
g_param_spec_boolean ("has-pixels",
- NULL, NULL,
+ "Has Pixels",
+ "Whether the store has GIMP_UNIT_PIXELS",
TRUE,
GIMP_PARAM_READWRITE));
g_object_class_install_property (object_class, PROP_HAS_PERCENT,
g_param_spec_boolean ("has-percent",
- NULL, NULL,
+ "Has Percent",
+ "Whether the store has GIMP_UNIT_PERCENT",
FALSE,
GIMP_PARAM_READWRITE));
g_object_class_install_property (object_class, PROP_SHORT_FORMAT,
g_param_spec_string ("short-format",
- NULL, NULL,
+ "Short Format",
+ "Format string for a short label",
"%a",
GIMP_PARAM_READWRITE));
g_object_class_install_property (object_class, PROP_LONG_FORMAT,
g_param_spec_string ("long-format",
- NULL, NULL,
+ "Long Format",
+ "Format string for a long label",
"%p",
GIMP_PARAM_READWRITE));
diff --git a/libgimpwidgets/gimpzoommodel.c b/libgimpwidgets/gimpzoommodel.c
index c74356b..c11a9b0 100644
--- a/libgimpwidgets/gimpzoommodel.c
+++ b/libgimpwidgets/gimpzoommodel.c
@@ -117,33 +117,63 @@ gimp_zoom_model_class_init (GimpZoomModelClass *klass)
object_class->set_property = gimp_zoom_model_set_property;
object_class->get_property = gimp_zoom_model_get_property;
+ /**
+ * GimpZoomModel:value:
+ *
+ * The zoom factor.
+ */
g_object_class_install_property (object_class, PROP_VALUE,
g_param_spec_double ("value",
- "Zoom factor", NULL,
+ "Value",
+ "Zoom factor",
ZOOM_MIN, ZOOM_MAX,
1.0,
GIMP_PARAM_READWRITE));
+ /**
+ * GimpZoomModel:minimum:
+ *
+ * The minimum zoom factor.
+ */
g_object_class_install_property (object_class, PROP_MINIMUM,
g_param_spec_double ("minimum",
- "Lower limit for the zoom factor", NULL,
+ "Minimum",
+ "Lower limit for the zoom factor",
ZOOM_MIN, ZOOM_MAX,
ZOOM_MIN,
GIMP_PARAM_READWRITE));
+ /**
+ * GimpZoomModel:maximum:
+ *
+ * The maximum zoom factor.
+ */
g_object_class_install_property (object_class, PROP_MAXIMUM,
g_param_spec_double ("maximum",
- "Upper limit for the zoom factor", NULL,
+ "Maximum",
+ "Upper limit for the zoom factor",
ZOOM_MIN, ZOOM_MAX,
ZOOM_MAX,
GIMP_PARAM_READWRITE));
+ /**
+ * GimpZoomModel:fraction:
+ *
+ * The zoom factor expressed as a fraction.
+ */
g_object_class_install_property (object_class, PROP_FRACTION,
g_param_spec_string ("fraction",
- "The zoom factor expressed as a fraction", NULL,
+ "Fraction",
+ "The zoom factor expressed as a fraction",
"1:1",
GIMP_PARAM_READABLE));
+ /**
+ * GimpZoomModel:percentage:
+ *
+ * The zoom factor expressed as percentage.
+ */
g_object_class_install_property (object_class, PROP_PERCENTAGE,
g_param_spec_string ("percentage",
- "The zoom factor expressed as a percentage", NULL,
+ "Percentage",
+ "The zoom factor expressed as a percentage",
"100%",
GIMP_PARAM_READABLE));
[
Date Prev][
Date Next] [
Thread Prev][
Thread Next]
[
Thread Index]
[
Date Index]
[
Author Index]
