From 4e5a0169e8b7d17becf7b8707e653348c5b2ceef Mon Sep 17 00:00:00 2001 From: Sven Neumann Date: Wed, 15 Aug 2007 06:55:33 +0000 Subject: [PATCH] documentation. 2007-08-15 Sven Neumann * libgimpwidgets/gimpcolorprofilestore.c: documentation. svn path=/trunk/; revision=23263 --- ChangeLog | 4 ++++ libgimpwidgets/gimpcolorprofilestore.c | 23 +++++++++++++++++++++-- 2 files changed, 25 insertions(+), 2 deletions(-) diff --git a/ChangeLog b/ChangeLog index 735ca364c5..7bcbe005f3 100644 --- a/ChangeLog +++ b/ChangeLog @@ -1,3 +1,7 @@ +2007-08-15 Sven Neumann + + * libgimpwidgets/gimpcolorprofilestore.c: documentation. + 2007-08-15 Sven Neumann * plug-ins/script-fu/scripts/Makefile.am diff --git a/libgimpwidgets/gimpcolorprofilestore.c b/libgimpwidgets/gimpcolorprofilestore.c index e6dab06502..a69e7d385c 100644 --- a/libgimpwidgets/gimpcolorprofilestore.c +++ b/libgimpwidgets/gimpcolorprofilestore.c @@ -220,9 +220,19 @@ gimp_color_profile_store_get_property (GObject *object, /** * gimp_color_profile_store_new: - * @history: + * @history: filename of the profilerc (or %NULL for no history) * - * Return value: a new #GimpColorProfileStore. + * Creates a new #GimpColorProfileStore object and populates it with + * last used profiles read from the file @history. The updated history + * is written back to disk when the store is disposed. + * + * The filename passed as @history is typically created using the + * following code snippet: + * + * gchar *history = gimp_personal_rc_file ("profilerc"); + * + * + * Return value: a new #GimpColorProfileStore * * Since: GIMP 2.4 **/ @@ -240,6 +250,15 @@ gimp_color_profile_store_new (const gchar *history) * @filename: * @label: * + * Adds an item to the #GimpColorProfileStore. Items added with this + * function will be kept at the top, separated from the history of last + * used items. + * + * This function is often used to add a selectable item for the %NULL + * filename. If you pass %NULL for both @filename and @label, the + * @label will be set to the string "None" for you (and translated for + * the user). + * * Since: GIMP 2.4 **/ void