libgimpwidgets/gimpenumcombobox.c improved API docs.

2005-01-24  Michael Natterer  <mitch@gimp.org>

	* libgimpwidgets/gimpenumcombobox.c
	* libgimpwidgets/gimpenumstore.[ch]: improved API docs.
This commit is contained in:
Michael Natterer 2005-01-23 23:16:28 +00:00 committed by Sven Neumann
parent 8d3c38c94b
commit fba0915d06
4 changed files with 20 additions and 9 deletions

View File

@ -1,3 +1,8 @@
2005-01-24 Michael Natterer <mitch@gimp.org>
* libgimpwidgets/gimpenumcombobox.c
* libgimpwidgets/gimpenumstore.[ch]: improved API docs.
2005-01-24 Michael Natterer <mitch@gimp.org>
Enabled closing docks with Ctrl-W:

View File

@ -1,7 +1,7 @@
/* LIBGIMP - The GIMP Library
* Copyright (C) 1995-1997 Peter Mattis and Spencer Kimball
*
* gimpenumcombobox.h
* gimpenumcombobox.c
* Copyright (C) 2004 Sven Neumann <sven@gimp.org>
*
* This library is free software; you can redistribute it and/or
@ -66,7 +66,9 @@ gimp_enum_combo_box_get_type (void)
*
* Creates a #GtkComboBox readily filled with all enum values from a
* given @enum_type. The enum needs to be registered to the type
* system and should have translatable value names.
* system. It should also have %GimpEnumDesc descriptions registered
* that contain translatable value names. This is the case for the
* enums used in the GIMP PDB functions.
*
* This is just a convenience function. If you need more control over
* the enum values that appear in the combo_box, you can create your
@ -100,8 +102,9 @@ gimp_enum_combo_box_new (GType enum_type)
* @combo_box: a #GimpEnumComboBox
* @stock_prefix: a prefix to create icon stock ID from enum values
*
* Attempts to create and set icons for all items in the
* @combo_box. See gimp_enum_store_set_icons() for more info.
* Attempts to create stock icons for all items in the @combo_box. See
* gimp_enum_store_set_icons() to find out what to use for
* @stock_prefix.
*
* Since: GIMP 2.4
**/

View File

@ -146,7 +146,8 @@ gimp_enum_store_new (GType enum_type)
* @maximum: the maximum value to include
*
* Creates a new #GimpEnumStore like gimp_enum_store_new() but allows
* to limit the enum values to a certain range.
* to limit the enum values to a certain range. Values smaller than
* @minimum or larger than @maximum are not added to the store.
*
* Return value: a new #GimpEnumStore.
*
@ -186,7 +187,8 @@ gimp_enum_store_new_with_range (GType enum_type,
* @...: a list of enum values (exactly @n_values)
*
* Creates a new #GimpEnumStore like gimp_enum_store_new() but allows
* to list the enum values that should be added to the store.
* to expliticely list the enum values that should be added to the
* store.
*
* Return value: a new #GimpEnumStore.
*
@ -257,8 +259,9 @@ gimp_enum_store_new_with_values_valist (GType enum_type,
* @stock_prefix: a prefix to create icon stock ID from enum values
*
* Creates a stock ID for each enum value in the @store by appending
* the value's nick to the given @stock_prefix inserting a hyphen
* between them.
* the value's nick to the given @stock_prefix, separated by a hyphen.
*
* See also: gimp_enum_combo_box_set_stock_prefix().
*
* Since: GIMP 2.4
**/

View File

@ -1,7 +1,7 @@
/* LIBGIMP - The GIMP Library
* Copyright (C) 1995-1997 Peter Mattis and Spencer Kimball
*
* gimpintstore.c
* gimpenumstore.h
* Copyright (C) 2004 Sven Neumann <sven@gimp.org>
*
* This library is free software; you can redistribute it and/or