dnrops
/
gimp
mirror of https://github.com/GNOME/gimp.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

libgimpconfig: move docs from template files to inline comments

This commit is contained in:
Michael Natterer 2010-06-29 20:57:52 +02:00
parent e74989282b
commit 1af54c7874
23 changed files with 92 additions and 1188 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

1
devel-docs/libgimpconfig/.gitignore vendored
View File

@ -12,6 +12,7 @@
/libgimpconfig-undeclared.txt
/libgimpconfig-undocumented.txt
/html
/tmpl
/xml
/version
/.libs

2
devel-docs/libgimpconfig/tmpl/.gitignore vendored
View File

@ -1,2 +0,0 @@
/libgimpconfig-unused.sgml
/*.bak

110
devel-docs/libgimpconfig/tmpl/gimpcolorconfig.sgml
View File

@ -1,110 +0,0 @@
<!-- ##### SECTION Title ##### -->
GimpColorConfig
<!-- ##### SECTION Short_Description ##### -->
<!-- ##### SECTION Long_Description ##### -->
<para>
</para>
<!-- ##### SECTION See_Also ##### -->
<para>
</para>
<!-- ##### SECTION Stability_Level ##### -->
<!-- ##### STRUCT GimpColorConfig ##### -->
<para>
</para>
@mode:
@rgb_profile:
@cmyk_profile:
@display_profile:
@display_profile_from_gdk:
@printer_profile:
@display_intent:
@simulation_intent:
@display_module:
@simulation_gamut_check:
@out_of_gamut_color:
<!-- ##### ARG GimpColorConfig:cmyk-profile ##### -->
<para>
</para>
<!-- ##### ARG GimpColorConfig:display-module ##### -->
<para>
</para>
<!-- ##### ARG GimpColorConfig:display-profile ##### -->
<para>
</para>
<!-- ##### ARG GimpColorConfig:display-profile-from-gdk ##### -->
<para>
</para>
<!-- ##### ARG GimpColorConfig:display-rendering-intent ##### -->
<para>
</para>
<!-- ##### ARG GimpColorConfig:mode ##### -->
<para>
</para>
<!-- ##### ARG GimpColorConfig:out-of-gamut-color ##### -->
<para>
</para>
<!-- ##### ARG GimpColorConfig:printer-profile ##### -->
<para>
</para>
<!-- ##### ARG GimpColorConfig:rgb-profile ##### -->
<para>
</para>
<!-- ##### ARG GimpColorConfig:simulation-gamut-check ##### -->
<para>
</para>
<!-- ##### ARG GimpColorConfig:simulation-rendering-intent ##### -->
<para>
</para>
<!-- ##### ENUM GimpColorManagementMode ##### -->
<para>
</para>
@GIMP_COLOR_MANAGEMENT_OFF:
@GIMP_COLOR_MANAGEMENT_DISPLAY:
@GIMP_COLOR_MANAGEMENT_SOFTPROOF:
<!-- ##### ENUM GimpColorRenderingIntent ##### -->
<para>
</para>
@GIMP_COLOR_RENDERING_INTENT_PERCEPTUAL:
@GIMP_COLOR_RENDERING_INTENT_RELATIVE_COLORIMETRIC:
@GIMP_COLOR_RENDERING_INTENT_SATURATION:
@GIMP_COLOR_RENDERING_INTENT_ABSOLUTE_COLORIMETRIC:

42
devel-docs/libgimpconfig/tmpl/gimpconfig-deserialize.sgml
View File

@ -1,42 +0,0 @@
<!-- ##### SECTION Title ##### -->
gimpconfig-deserialize
<!-- ##### SECTION Short_Description ##### -->
Deserializing code for libgimpconfig.
<!-- ##### SECTION Long_Description ##### -->
<para>
Deserializing code for libgimpconfig.
</para>
<!-- ##### SECTION See_Also ##### -->
<para>
</para>
<!-- ##### SECTION Stability_Level ##### -->
<!-- ##### FUNCTION gimp_config_deserialize_properties ##### -->
<para>
</para>
@config:
@scanner:
@nest_level:
@Returns:
<!-- ##### FUNCTION gimp_config_deserialize_property ##### -->
<para>
</para>
@config:
@scanner:
@nest_level:
@Returns:

45
devel-docs/libgimpconfig/tmpl/gimpconfig-error.sgml
View File

@ -1,45 +0,0 @@
<!-- ##### SECTION Title ##### -->
gimpconfig-error
<!-- ##### SECTION Short_Description ##### -->
<!-- ##### SECTION Long_Description ##### -->
<para>
</para>
<!-- ##### SECTION See_Also ##### -->
<para>
</para>
<!-- ##### SECTION Stability_Level ##### -->
<!-- ##### ENUM GimpConfigError ##### -->
<para>
</para>
@GIMP_CONFIG_ERROR_OPEN:
@GIMP_CONFIG_ERROR_OPEN_ENOENT:
@GIMP_CONFIG_ERROR_WRITE:
@GIMP_CONFIG_ERROR_PARSE:
@GIMP_CONFIG_ERROR_VERSION:
<!-- ##### MACRO GIMP_CONFIG_ERROR ##### -->
<para>
</para>
<!-- ##### FUNCTION gimp_config_error_quark ##### -->
<para>
</para>
@Returns:

142
devel-docs/libgimpconfig/tmpl/gimpconfig-iface.sgml
View File

@ -1,142 +0,0 @@
<!-- ##### SECTION Title ##### -->
gimpconfig-iface
<!-- ##### SECTION Short_Description ##### -->
High-level API for libgimpconfig.
<!-- ##### SECTION Long_Description ##### -->
<para>
High-level API functions for libgimpconfig.
</para>
<!-- ##### SECTION See_Also ##### -->
<para>
</para>
<!-- ##### SECTION Stability_Level ##### -->
<!-- ##### STRUCT GimpConfig ##### -->
<para>
</para>
<!-- ##### STRUCT GimpConfigInterface ##### -->
<para>
</para>
<!-- ##### FUNCTION gimp_config_serialize_to_file ##### -->
<para>
</para>
@config:
@filename:
@header:
@footer:
@data
@data:
@error:
@Returns:
<!-- ##### FUNCTION gimp_config_serialize_to_fd ##### -->
<para>
</para>
@config:
@fd:
@data:
@Returns:
<!-- ##### FUNCTION gimp_config_serialize_to_string ##### -->
<para>
</para>
@config:
@data:
@Returns:
<!-- ##### FUNCTION gimp_config_deserialize_file ##### -->
<para>
</para>
@config:
@filename:
@data:
@error:
@Returns:
<!-- ##### FUNCTION gimp_config_deserialize_string ##### -->
<para>
</para>
@config:
@text:
@text_len:
@data:
@error:
@Returns:
<!-- ##### FUNCTION gimp_config_deserialize_return ##### -->
<para>
</para>
@scanner:
@expected_token:
@nest_level:
@Returns:
<!-- ##### FUNCTION gimp_config_duplicate ##### -->
<para>
</para>
@config:
@Returns:
<!-- ##### FUNCTION gimp_config_is_equal_to ##### -->
<para>
</para>
@a:
@b:
@Returns:
<!-- ##### FUNCTION gimp_config_reset ##### -->
<para>
</para>
@config:
<!-- ##### FUNCTION gimp_config_copy ##### -->
<para>
</para>
@src:
@dest:
@flags:
@Returns:

275
devel-docs/libgimpconfig/tmpl/gimpconfig-params.sgml
View File

@ -1,275 +0,0 @@
<!-- ##### SECTION Title ##### -->
gimpconfig-params
<!-- ##### SECTION Short_Description ##### -->
<!-- ##### SECTION Long_Description ##### -->
<para>
</para>
<!-- ##### SECTION See_Also ##### -->
<para>
</para>
<!-- ##### SECTION Stability_Level ##### -->
<!-- ##### MACRO GIMP_CONFIG_PARAM_SERIALIZE ##### -->
<para>
</para>
<!-- ##### MACRO GIMP_CONFIG_PARAM_AGGREGATE ##### -->
<para>
</para>
<!-- ##### MACRO GIMP_CONFIG_PARAM_RESTART ##### -->
<para>
</para>
<!-- ##### MACRO GIMP_CONFIG_PARAM_CONFIRM ##### -->
<para>
</para>
<!-- ##### MACRO GIMP_CONFIG_PARAM_DEFAULTS ##### -->
<para>
</para>
<!-- ##### MACRO GIMP_CONFIG_PARAM_IGNORE ##### -->
<para>
</para>
<!-- ##### MACRO GIMP_CONFIG_PARAM_FLAGS ##### -->
<para>
</para>
<!-- ##### MACRO GIMP_CONFIG_INSTALL_PROP_BOOLEAN ##### -->
<para>
</para>
@class:
@id:
@name:
@blurb:
@default:
@flags:
<!-- ##### MACRO GIMP_CONFIG_INSTALL_PROP_BOXED ##### -->
<para>
</para>
@class:
@id:
@name:
@blurb:
@boxed_type:
@flags:
<!-- ##### MACRO GIMP_CONFIG_INSTALL_PROP_RGB ##### -->
<para>
</para>
@class:
@id:
@name:
@blurb:
@has_alpha:
@default:
@flags:
<!-- ##### MACRO GIMP_CONFIG_INSTALL_PROP_DOUBLE ##### -->
<para>
</para>
@class:
@id:
@name:
@blurb:
@min:
@max:
@default:
@flags:
<!-- ##### MACRO GIMP_CONFIG_INSTALL_PROP_RESOLUTION ##### -->
<para>
</para>
@class:
@id:
@name:
@blurb:
@default:
@flags:
<!-- ##### MACRO GIMP_CONFIG_INSTALL_PROP_ENUM ##### -->
<para>
</para>
@class:
@id:
@name:
@blurb:
@enum_type:
@default:
@flags:
<!-- ##### MACRO GIMP_CONFIG_INSTALL_PROP_INT ##### -->
<para>
</para>
@class:
@id:
@name:
@blurb:
@min:
@max:
@default:
@flags:
<!-- ##### MACRO GIMP_CONFIG_INSTALL_PROP_MATRIX2 ##### -->
<para>
</para>
@class:
@id:
@name:
@blurb:
@default:
@flags:
<!-- ##### MACRO GIMP_CONFIG_INSTALL_PROP_MEMSIZE ##### -->
<para>
</para>
@class:
@id:
@name:
@blurb:
@min:
@max:
@default:
@flags:
<!-- ##### MACRO GIMP_CONFIG_INSTALL_PROP_PATH ##### -->
<para>
</para>
@class:
@id:
@name:
@blurb:
@path_type:
@default:
@flags:
<!-- ##### MACRO GIMP_CONFIG_INSTALL_PROP_STRING ##### -->
<para>
</para>
@class:
@id:
@name:
@blurb:
@default:
@flags:
<!-- ##### MACRO GIMP_CONFIG_INSTALL_PROP_UINT ##### -->
<para>
</para>
@class:
@id:
@name:
@blurb:
@min:
@max:
@default:
@flags:
<!-- ##### MACRO GIMP_CONFIG_INSTALL_PROP_UNIT ##### -->
<para>
</para>
@class:
@id:
@name:
@blurb:
@pixels:
@percent:
@default:
@flags:
<!-- ##### MACRO GIMP_CONFIG_INSTALL_PROP_OBJECT ##### -->
<para>
</para>
@class:
@id:
@name:
@blurb:
@object_type:
@flags:
<!-- ##### MACRO GIMP_CONFIG_INSTALL_PROP_POINTER ##### -->
<para>
</para>
@class:
@id:
@name:
@blurb:
@flags:

98
devel-docs/libgimpconfig/tmpl/gimpconfig-path.sgml
View File

@ -1,98 +0,0 @@
<!-- ##### SECTION Title ##### -->
gimpconfig-path
<!-- ##### SECTION Short_Description ##### -->
<!-- ##### SECTION Long_Description ##### -->
<para>
</para>
<!-- ##### SECTION See_Also ##### -->
<para>
</para>
<!-- ##### SECTION Stability_Level ##### -->
<!-- ##### ENUM GimpConfigPathType ##### -->
<para>
</para>
@GIMP_CONFIG_PATH_FILE:
@GIMP_CONFIG_PATH_FILE_LIST:
@GIMP_CONFIG_PATH_DIR:
@GIMP_CONFIG_PATH_DIR_LIST:
<!-- ##### FUNCTION gimp_param_spec_config_path ##### -->
<para>
</para>
@name:
@nick:
@blurb:
@type:
@default_value:
@flags:
@Returns:
<!-- ##### FUNCTION gimp_param_spec_config_path_type ##### -->
<para>
</para>
@pspec:
@Returns:
<!-- ##### FUNCTION gimp_config_path_expand ##### -->
<para>
</para>
@path:
@recode:
@error:
@Returns:
<!-- ##### FUNCTION gimp_config_build_data_path ##### -->
<para>
</para>
@name:
@Returns:
<!-- ##### FUNCTION gimp_config_build_writable_path ##### -->
<para>
</para>
@name:
@Returns:
<!-- ##### FUNCTION gimp_config_build_plug_in_path ##### -->
<para>
</para>
@name:
@Returns:
<!-- ##### MACRO GIMP_VALUE_HOLDS_CONFIG_PATH ##### -->
<para>
</para>
@value:

73
devel-docs/libgimpconfig/tmpl/gimpconfig-serialize.sgml
View File

@ -1,73 +0,0 @@
<!-- ##### SECTION Title ##### -->
gimpconfig-serialize
<!-- ##### SECTION Short_Description ##### -->
Serializing for libgimpconfig.
<!-- ##### SECTION Long_Description ##### -->
<para>
Serializing interface for libgimpconfig.
</para>
<!-- ##### SECTION See_Also ##### -->
<para>
</para>
<!-- ##### SECTION Stability_Level ##### -->
<!-- ##### FUNCTION gimp_config_serialize_properties ##### -->
<para>
</para>
@config:
@writer:
@Returns:
<!-- ##### FUNCTION gimp_config_serialize_changed_properties ##### -->
<para>
</para>
@config:
@writer:
@Returns:
<!-- ##### FUNCTION gimp_config_serialize_property ##### -->
<para>
</para>
@config:
@param_spec:
@writer:
@Returns:
<!-- ##### FUNCTION gimp_config_serialize_property_by_name ##### -->
<para>
</para>
@config:
@prop_name:
@writer:
@Returns:
<!-- ##### FUNCTION gimp_config_serialize_value ##### -->
<para>
</para>
@value:
@str:
@escaped:
@Returns:

68
devel-docs/libgimpconfig/tmpl/gimpconfig-utils.sgml
View File

@ -1,68 +0,0 @@
<!-- ##### SECTION Title ##### -->
gimpconfig-utils
<!-- ##### SECTION Short_Description ##### -->
Miscellaneous utility functions for libgimpconfig.
<!-- ##### SECTION Long_Description ##### -->
<para>
Miscellaneous utility functions for libgimpconfig.
</para>
<!-- ##### SECTION See_Also ##### -->
<para>
</para>
<!-- ##### SECTION Stability_Level ##### -->
<!-- ##### FUNCTION gimp_config_diff ##### -->
<para>
</para>
@a:
@b:
@flags:
@Returns:
<!-- ##### FUNCTION gimp_config_sync ##### -->
<para>
</para>
@src:
@dest:
@flags:
@Returns:
<!-- ##### FUNCTION gimp_config_reset_properties ##### -->
<para>
</para>
@object:
<!-- ##### FUNCTION gimp_config_reset_property ##### -->
<para>
</para>
@object:
@property_name:
<!-- ##### FUNCTION gimp_config_string_append_escaped ##### -->
<para>
</para>
@string:
@val:

28
devel-docs/libgimpconfig/tmpl/gimpconfigtypes.sgml
View File

@ -1,28 +0,0 @@
<!-- ##### SECTION Title ##### -->
gimpconfigtypes
<!-- ##### SECTION Short_Description ##### -->
<!-- ##### SECTION Long_Description ##### -->
<para>
</para>
<!-- ##### SECTION See_Also ##### -->
<para>
</para>
<!-- ##### STRUCT GimpConfig ##### -->
<para>
</para>
<!-- ##### STRUCT GimpConfigWriter ##### -->
<para>
</para>

166
devel-docs/libgimpconfig/tmpl/gimpconfigwriter.sgml
View File

@ -1,166 +0,0 @@
<!-- ##### SECTION Title ##### -->
gimpconfigwriter
<!-- ##### SECTION Short_Description ##### -->
Functions for writing config info to a file for libgimpconfig.
<!-- ##### SECTION Long_Description ##### -->
<para>
Functions for writing config info to a file for libgimpconfig.
</para>
<!-- ##### SECTION See_Also ##### -->
<para>
</para>
<!-- ##### SECTION Stability_Level ##### -->
<!-- ##### STRUCT GimpConfigWriter ##### -->
<para>
</para>
<!-- ##### FUNCTION gimp_config_writer_new_file ##### -->
<para>
</para>
@filename:
@atomic:
@header:
@error:
@Returns:
<!-- ##### FUNCTION gimp_config_writer_new_fd ##### -->
<para>
</para>
@fd:
@Returns:
<!-- ##### FUNCTION gimp_config_writer_new_string ##### -->
<para>
</para>
@string:
@Returns:
<!-- ##### FUNCTION gimp_config_writer_open ##### -->
<para>
</para>
@writer:
@name:
<!-- ##### FUNCTION gimp_config_writer_comment_mode ##### -->
<para>
</para>
@writer:
@enable:
<!-- ##### FUNCTION gimp_config_writer_print ##### -->
<para>
</para>
@writer:
@string:
@len:
<!-- ##### FUNCTION gimp_config_writer_printf ##### -->
<para>
</para>
@writer:
@format:
@Varargs:
<!-- ##### FUNCTION gimp_config_writer_identifier ##### -->
<para>
</para>
@writer:
@identifier:
<!-- ##### FUNCTION gimp_config_writer_string ##### -->
<para>
</para>
@writer:
@string:
<!-- ##### FUNCTION gimp_config_writer_data ##### -->
<para>
</para>
@writer:
@length:
@data:
<!-- ##### FUNCTION gimp_config_writer_comment ##### -->
<para>
</para>
@writer:
@comment:
<!-- ##### FUNCTION gimp_config_writer_linefeed ##### -->
<para>
</para>
@writer:
<!-- ##### FUNCTION gimp_config_writer_revert ##### -->
<para>
</para>
@writer:
<!-- ##### FUNCTION gimp_config_writer_close ##### -->
<para>
</para>
@writer:
<!-- ##### FUNCTION gimp_config_writer_finish ##### -->
<para>
</para>
@writer:
@footer:
@error:
@Returns:

139
devel-docs/libgimpconfig/tmpl/gimpscanner.sgml
View File

@ -1,139 +0,0 @@
<!-- ##### SECTION Title ##### -->
gimpscanner
<!-- ##### SECTION Short_Description ##### -->
<!-- ##### SECTION Long_Description ##### -->
<para>
</para>
<!-- ##### SECTION See_Also ##### -->
<para>
</para>
<!-- ##### SECTION Stability_Level ##### -->
<!-- ##### FUNCTION gimp_scanner_new_file ##### -->
<para>
</para>
@filename:
@error:
@Returns:
<!-- ##### FUNCTION gimp_scanner_new_string ##### -->
<para>
</para>
@text:
@text_len:
@error:
@Returns:
<!-- ##### FUNCTION gimp_scanner_destroy ##### -->
<para>
</para>
@scanner:
<!-- ##### FUNCTION gimp_scanner_parse_token ##### -->
<para>
</para>
@scanner:
@token:
@Returns:
<!-- ##### FUNCTION gimp_scanner_parse_identifier ##### -->
<para>
</para>
@scanner:
@identifier:
@Returns:
<!-- ##### FUNCTION gimp_scanner_parse_string ##### -->
<para>
</para>
@scanner:
@dest:
@Returns:
<!-- ##### FUNCTION gimp_scanner_parse_string_no_validate ##### -->
<para>
</para>
@scanner:
@dest:
@Returns:
<!-- ##### FUNCTION gimp_scanner_parse_data ##### -->
<para>
</para>
@scanner:
@length:
@dest:
@Returns:
<!-- ##### FUNCTION gimp_scanner_parse_int ##### -->
<para>
</para>
@scanner:
@dest:
@Returns:
<!-- ##### FUNCTION gimp_scanner_parse_float ##### -->
<para>
</para>
@scanner:
@dest:
@Returns:
<!-- ##### FUNCTION gimp_scanner_parse_color ##### -->
<para>
</para>
@scanner:
@dest:
@Returns:
<!-- ##### FUNCTION gimp_scanner_parse_matrix2 ##### -->
<para>
</para>
@scanner:
@dest:
@Returns:

9
libgimpconfig/gimpcolorconfig.c
View File

@ -37,6 +37,15 @@
#include "libgimp/libgimp-intl.h"
/**
* SECTION: gimpcolorconfig
* @title: GimpColorConfig
* @short_description: Color management settings.
*
* Color management settings.
**/
#define COLOR_MANAGEMENT_MODE_BLURB \
N_("Mode of operation for color management.")
#define DISPLAY_PROFILE_BLURB \

9
libgimpconfig/gimpconfig-deserialize.c
View File

@ -39,6 +39,15 @@
#include "libgimp/libgimp-intl.h"
/**
* SECTION: gimpconfig-deserialize
* @title: GimpConfig-deserialize
* @short_description: Deserializing code for libgimpconfig.
*
* Deserializing code for libgimpconfig.
**/
/*
* All functions return G_TOKEN_RIGHT_PAREN on success,
* the GTokenType they would have expected but didn't get

9
libgimpconfig/gimpconfig-error.c
View File

@ -26,6 +26,15 @@
#include "gimpconfig-error.h"
/**
* SECTION: gimpconfig-error
* @title: GimpConfig-error
* @short_description: Error utils for libgimpconfig.
*
* Error utils for libgimpconfig.
**/
/**
* gimp_config_error_quark:
*

9
libgimpconfig/gimpconfig-iface.c
View File

@ -40,6 +40,15 @@
#include "libgimp/libgimp-intl.h"
/**
* SECTION: gimpconfig-iface
* @title: GimpConfig-iface
* @short_description: High-level API for libgimpconfig.
*
* High-level API for libgimpconfig.
**/
/*
* The GimpConfig serialization and deserialization interface.
*/

9
libgimpconfig/gimpconfig-params.h
View File

@ -27,6 +27,15 @@ G_BEGIN_DECLS
/* For information look into the C source or the html documentation */
/**
* SECTION: gimpconfig-params
* @title: GimpConfig-params
* @short_description: Macros and defines to install config properties.
*
* Macros and defines to install config properties.
**/
/*
* GIMP_CONFIG_PARAM_SERIALIZE - A property that can and should be
* serialized and deserialized.

9
libgimpconfig/gimpconfig-path.c
View File

@ -34,6 +34,15 @@
#include "libgimp/libgimp-intl.h"
/**
* SECTION: gimpconfig-path
* @title: GimpConfig-path
* @short_description: File path utilities for libgimpconfig.
*
* File path utilities for libgimpconfig.
**/
/**
* gimp_config_path_get_type:
*

9
libgimpconfig/gimpconfig-serialize.c
View File

@ -36,6 +36,15 @@
#include "gimpconfig-utils.h"
/**
* SECTION: gimpconfig-serialize
* @title: GimpConfig-serialize
* @short_description: Serializing for libgimpconfig.
*
* Serializing interface for libgimpconfig.
**/
static gboolean gimp_config_serialize_rgb (const GValue *value,
GString *str,
gboolean has_alpha);

9
libgimpconfig/gimpconfig-utils.c
View File

@ -33,6 +33,15 @@
#include "gimpconfig-utils.h"
/**
* SECTION: gimpconfig-utils
* @title: GimpConfig-utils
* @short_description: Miscellaneous utility functions for libgimpconfig.
*
* Miscellaneous utility functions for libgimpconfig.
**/
static gboolean
gimp_config_diff_property (GObject *a,
GObject *b,

10
libgimpconfig/gimpconfigwriter.c
View File

@ -51,6 +51,16 @@
#include "libgimp/libgimp-intl.h"
/**
* SECTION: gimpconfigwriter
* @title: GimpConfigWriter
* @short_description: Functions for writing config info to a file for
* libgimpconfig.
*
* Functions for writing config info to a file for libgimpconfig.
**/
struct _GimpConfigWriter
{
gint fd;

9
libgimpconfig/gimpscanner.c
View File

@ -37,6 +37,15 @@
#include "libgimp/libgimp-intl.h"
/**
* SECTION: gimpscanner
* @title: GimpScanner
* @short_description: A wrapper around #GScanner with some convenience API.
*
* A wrapper around #GScanner with some convenience API.
**/
typedef struct
{
gchar *name;