Commit 889caf60 authored by Sven Neumann's avatar Sven Neumann Committed by Sven Neumann

added API documentation.

2005-04-07  Sven Neumann  <sven@gimp.org>

	* libgimpconfig/gimpconfig-path.c: added API documentation.
parent 11fea041
2005-04-07 Sven Neumann <sven@gimp.org>
* libgimpconfig/gimpconfig-path.c: added API documentation.
2005-04-07 Sven Neumann <sven@gimp.org>
* app/config/gimpcoreconfig.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)
*
* 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.
*
* Returns:
* 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)
*
* 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.
*
* Returns:
* 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)
*
* 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:
* Returns: a newly allocated string
*
* Since: GIMP 2.4
**/
......
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment