From 8cfef5e60d0bc77a05b2ed0c0cfb95feff57aa3e Mon Sep 17 00:00:00 2001 From: Michael Natterer Date: Fri, 9 Aug 2019 12:32:09 +0200 Subject: [PATCH] libgimpwidgets: more docs and annotations --- libgimpwidgets/gimppropwidgets.c | 16 ++++++++++++++-- libgimpwidgets/gimppropwidgets.h | 2 +- libgimpwidgets/gimpwidgetsutils.c | 16 ++++++++++++++++ 3 files changed, 31 insertions(+), 3 deletions(-) diff --git a/libgimpwidgets/gimppropwidgets.c b/libgimpwidgets/gimppropwidgets.c index 5eff3c20ad..1a5c247e51 100644 --- a/libgimpwidgets/gimppropwidgets.c +++ b/libgimpwidgets/gimppropwidgets.c @@ -2532,11 +2532,23 @@ static void gimp_prop_path_editor_writable_notify (GObject *config, GParamSpec *param_spec, GimpPathEditor *editor); +/** + * gimp_prop_path_editor_new: + * @config: object to which property is attached. + * @path_property_name: name of path property. + * @writable_property_name: name of writable path property. + * @filechooser_title: window title of #GtkFileChooserDialog widget. + * + * Creates a #GimpPathEditor to edit the specified path and writable + * path properties. + * + * Returns: (transfer full): A new #GimpPathEditor. + **/ GtkWidget * gimp_prop_path_editor_new (GObject *config, const gchar *path_property_name, const gchar *writable_property_name, - const gchar *filesel_title) + const gchar *filechooser_title) { GParamSpec *path_param_spec; GParamSpec *writable_param_spec = NULL; @@ -2568,7 +2580,7 @@ gimp_prop_path_editor_new (GObject *config, filename = value ? gimp_config_path_expand (value, TRUE, NULL) : NULL; g_free (value); - editor = gimp_path_editor_new (filesel_title, filename); + editor = gimp_path_editor_new (filechooser_title, filename); g_free (filename); if (writable_property_name) diff --git a/libgimpwidgets/gimppropwidgets.h b/libgimpwidgets/gimppropwidgets.h index eb5d95c469..c94bca2ef2 100644 --- a/libgimpwidgets/gimppropwidgets.h +++ b/libgimpwidgets/gimppropwidgets.h @@ -167,7 +167,7 @@ GtkWidget * gimp_prop_file_chooser_button_new_with_dialog (GObject *conf GtkWidget * gimp_prop_path_editor_new (GObject *config, const gchar *path_property_name, const gchar *writable_property_name, - const gchar *filesel_title); + const gchar *filechooser_title); /* GParamInt, GParamUInt, GParamDouble unit: GimpParamUnit */ diff --git a/libgimpwidgets/gimpwidgetsutils.c b/libgimpwidgets/gimpwidgetsutils.c index 3c0478f284..4324d26272 100644 --- a/libgimpwidgets/gimpwidgetsutils.c +++ b/libgimpwidgets/gimpwidgetsutils.c @@ -732,6 +732,22 @@ transform_cache_config_notify (GObject *config, g_printerr ("deleted cache %p\n", cache); } +/** + * gimp_widget_get_color_transform: + * @widget: a #GtkWidget + * @config: a #GimpColorConfig + * @src_profile: a #GimpColorProfile + * @src_format: Babl format for the transform's source pixels + * @dest_format: Babl format for the transforms's destination pixels + * + * This function returns the #GimpColorTransform that transforms pixels + * from @src_profile to the profile of the #GdkMonitor the @widget is + * displayed on. + * + * Returns: (nullable) (transfer full): the #GimpColorTransform. + * + * Since: 2.10 + **/ GimpColorTransform * gimp_widget_get_color_transform (GtkWidget *widget, GimpColorConfig *config,