From 889caf60c041e0c8354cd4642d8c9eb562eb358c Mon Sep 17 00:00:00 2001 From: Sven Neumann Date: Thu, 7 Apr 2005 17:19:47 +0000 Subject: [PATCH] added API documentation. 2005-04-07 Sven Neumann * libgimpconfig/gimpconfig-path.c: added API documentation. --- ChangeLog | 4 ++++ libgimpconfig/gimpconfig-path.c | 39 ++++++++++++++++++++++++++++----- 2 files changed, 37 insertions(+), 6 deletions(-) diff --git a/ChangeLog b/ChangeLog index 70af0af8ee..cc3ed09300 100644 --- a/ChangeLog +++ b/ChangeLog @@ -1,3 +1,7 @@ +2005-04-07 Sven Neumann + + * libgimpconfig/gimpconfig-path.c: added API documentation. + 2005-04-07 Sven Neumann * app/config/gimpcoreconfig.c diff --git a/libgimpconfig/gimpconfig-path.c b/libgimpconfig/gimpconfig-path.c index b8001a3165..8681c817d4 100644 --- a/libgimpconfig/gimpconfig-path.c +++ b/libgimpconfig/gimpconfig-path.c @@ -181,11 +181,21 @@ static gchar * gimp_config_path_expand_only (const gchar *path, GError **error); static inline gchar * gimp_config_path_extract_token (const gchar **str); + /** * gimp_config_build_data_path: - * @name: + * @name: directory name (in UTF-8 encoding) * - * Returns: + * Creates a search path as it is used in the gimprc file. The path + * returned by gimp_config_build_data_path() includes a directory + * below the user's gimp directory and one in the system-wide data + * directory. + * + * Note that you cannot use this path directly with gimp_path_parse(). + * As it is in the gimprc notation, you first need to expand and + * recode it using gimp_config_path_expand(). + * + * Returns: a newly allocated string * * Since: GIMP 2.4 **/ @@ -200,9 +210,18 @@ gimp_config_build_data_path (const gchar *name) /** * gimp_config_build_plug_in_path: - * @name: + * @name: directory name (in UTF-8 encoding) * - * Returns: + * Creates a search path as it is used in the gimprc file. The path + * returned by gimp_config_build_plug_in_path() includes a directory + * below the user's gimp directory and one in the system-wide plug-in + * directory. + * + * Note that you cannot use this path directly with gimp_path_parse(). + * As it is in the gimprc notation, you first need to expand and + * recode it using gimp_config_path_expand(). + * + * Returns: a newly allocated string * * Since: GIMP 2.4 **/ @@ -217,9 +236,17 @@ gimp_config_build_plug_in_path (const gchar *name) /** * gimp_config_build_writable_path: - * @name: + * @name: directory name (in UTF-8 encoding) * - * Returns: + * Creates a search path as it is used in the gimprc file. The path + * returned by gimp_config_build_writable_path() is just the writable + * parts of the search path constructed by gimp_config_build_data_path(). + * + * Note that you cannot use this path directly with gimp_path_parse(). + * As it is in the gimprc notation, you first need to expand and + * recode it using gimp_config_path_expand(). + * + * Returns: a newly allocated string * * Since: GIMP 2.4 **/