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

libgimpbase: move docs from template files to inline comments 

and remove all template files. Also fixed all gtk-doc warnings
and fixed/added some docs.
This commit is contained in:
Michael Natterer 2010-06-29 19:13:40 +02:00
parent 81925e424b
commit 3411c7b63a
42 changed files with 496 additions and 113 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

40
configure.ac
View File

@ -1924,14 +1924,54 @@ AC_CONFIG_COMMANDS([libgimpbase/gimpversion.h], [
G_BEGIN_DECLS
/**
* SECTION: gimpversion
* @title: gimpversion
* @short_description: Macros and constants useful for determining
* GIMP's version number and capabilities.
*
* Macros and constants useful for determining GIMP's version number and
* capabilities.
**/
_______EOF
cat >>$outfile <<_______EOF
/**
* GIMP_MAJOR_VERSION:
*
* The major GIMP version number.
**/
#define GIMP_MAJOR_VERSION ($gimp_major_ver)
/**
* GIMP_MINOR_VERSION:
*
* The minor GIMP version number.
**/
#define GIMP_MINOR_VERSION ($gimp_minor_ver)
/**
* GIMP_MICRO_VERSION:
*
* The micro GIMP version number.
**/
#define GIMP_MICRO_VERSION ($gimp_micro_ver)
/**
* GIMP_VERSION:
*
* The GIMP version as a string.
**/
#define GIMP_VERSION "$gimp_ver"
/**
* GIMP_API_VERSION:
*
* Since: GIMP 2.2
**/
#define GIMP_API_VERSION "$gimp_api_ver"
_______EOF
cat >>$outfile <<\_______EOF

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

@ -12,6 +12,7 @@
/libgimpbase-undeclared.txt
/libgimpbase-undocumented.txt
/html
/tmpl
/xml
/version
/*.bak

3
devel-docs/libgimpbase/libgimpbase-sections.txt
View File

@ -232,6 +232,7 @@ gimp_param_parasite_get_type
<SECTION>
<FILE>gimpparasiteio</FILE>
GIMP_PIXPIPE_MAXDIM
GimpPixPipeParams
gimp_pixpipe_params_init
gimp_pixpipe_params_parse
gimp_pixpipe_params_build
@ -258,6 +259,8 @@ gimp_unit_get_symbol
gimp_unit_get_abbreviation
gimp_unit_get_singular
gimp_unit_get_plural
gimp_pixels_to_units
gimp_units_to_pixels
GIMP_TYPE_UNIT
GIMP_TYPE_PARAM_UNIT
GIMP_IS_PARAM_SPEC_UNIT

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

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

7
devel-docs/libgimpbase/tmpl/gimpbaseenums.sgml
View File

@ -2,11 +2,11 @@
gimpbaseenums
<!-- ##### SECTION Short_Description ##### -->
Basic GIMP enumeration data types.
<!-- ##### SECTION Long_Description ##### -->
<para>
Basic GIMP enumeration data types.
</para>
<!-- ##### SECTION See_Also ##### -->
@ -17,6 +17,9 @@ Basic GIMP enumeration data types.
<!-- ##### SECTION Stability_Level ##### -->
<!-- ##### SECTION Image ##### -->
<!-- ##### ENUM GimpAddMaskType ##### -->
<para>

7
devel-docs/libgimpbase/tmpl/gimpbasetypes.sgml
View File

@ -2,11 +2,11 @@
gimpbasetypes
<!-- ##### SECTION Short_Description ##### -->
Translation between gettext translation domain identifier and GType.
<!-- ##### SECTION Long_Description ##### -->
<para>
Translation between gettext translation domain identifier and GType.
</para>
<!-- ##### SECTION See_Also ##### -->
@ -17,6 +17,9 @@ Translation between gettext translation domain identifier and GType.
<!-- ##### SECTION Stability_Level ##### -->
<!-- ##### SECTION Image ##### -->
<!-- ##### STRUCT GimpEnumDesc ##### -->
<para>

17
devel-docs/libgimpbase/tmpl/gimpchecks.sgml
View File

@ -2,11 +2,11 @@
gimpchecks
<!-- ##### SECTION Short_Description ##### -->
Constants and functions related to rendering checkerboards.
<!-- ##### SECTION Long_Description ##### -->
<para>
Constants and functions related to rendering checkerboards.
</para>
<!-- ##### SECTION See_Also ##### -->
@ -17,32 +17,33 @@ Constants and functions related to rendering checkerboards.
<!-- ##### SECTION Stability_Level ##### -->
<!-- ##### SECTION Image ##### -->
<!-- ##### MACRO GIMP_CHECK_SIZE ##### -->
<para>
The default checkerboard size in pixels. This is configurable in the
core but GIMP plug-ins can't access the user preference and should use
this constant instead.
</para>
<!-- ##### MACRO GIMP_CHECK_SIZE_SM ##### -->
<para>
The default small checkerboard size in pixels.
</para>
<!-- ##### MACRO GIMP_CHECK_DARK ##### -->
<para>
The dark gray value for the default checkerboard pattern.
</para>
<!-- ##### MACRO GIMP_CHECK_LIGHT ##### -->
<para>
The light gray value for the default checkerboard pattern.
</para>

4
devel-docs/libgimpbase/tmpl/gimpcpuaccel.sgml
View File

@ -17,6 +17,9 @@ gimpcpuaccel
<!-- ##### SECTION Stability_Level ##### -->
<!-- ##### SECTION Image ##### -->
<!-- ##### ENUM GimpCpuAccelFlags ##### -->
<para>
@ -36,6 +39,7 @@ gimpcpuaccel
</para>
@void:
@Returns:

7
devel-docs/libgimpbase/tmpl/gimpdatafiles.sgml
View File

@ -2,11 +2,11 @@
gimpdatafiles
<!-- ##### SECTION Short_Description ##### -->
Functions to handle GIMP data files.
<!-- ##### SECTION Long_Description ##### -->
<para>
Functions to handle GIMP data files.
</para>
<!-- ##### SECTION See_Also ##### -->
@ -17,6 +17,9 @@ Functions to handle GIMP data files.
<!-- ##### SECTION Stability_Level ##### -->
<!-- ##### SECTION Image ##### -->
<!-- ##### STRUCT GimpDatafileData ##### -->
<para>

14
devel-docs/libgimpbase/tmpl/gimpenv.sgml
View File

@ -2,12 +2,11 @@
gimpenv
<!-- ##### SECTION Short_Description ##### -->
Functions to access the GIMP environment.
<!-- ##### SECTION Long_Description ##### -->
<para>
A set of functions to find the locations of GIMP's data directories and
configuration files.
</para>
<!-- ##### SECTION See_Also ##### -->
@ -18,6 +17,9 @@ configuration files.
<!-- ##### SECTION Stability_Level ##### -->
<!-- ##### SECTION Image ##### -->
<!-- ##### FUNCTION gimp_env_init ##### -->
<para>
@ -31,6 +33,7 @@ configuration files.
</para>
@void:
@Returns:
@ -39,6 +42,7 @@ configuration files.
</para>
@void:
@Returns:
@ -47,6 +51,7 @@ configuration files.
</para>
@void:
@Returns:
@ -55,6 +60,7 @@ configuration files.
</para>
@void:
@Returns:
@ -63,6 +69,7 @@ configuration files.
</para>
@void:
@Returns:
@ -89,6 +96,7 @@ configuration files.
</para>
@void:
@Returns:

26
devel-docs/libgimpbase/tmpl/gimplimits.sgml
View File

@ -2,11 +2,10 @@
gimplimits
<!-- ##### SECTION Short_Description ##### -->
Boundaries of some GIMP data types and some global constants.
<!-- ##### SECTION Long_Description ##### -->
<para>
Boundaries of some GIMP data types and some global constants.
</para>
@ -18,47 +17,40 @@ Boundaries of some GIMP data types and some global constants.
<!-- ##### SECTION Stability_Level ##### -->
<!-- ##### SECTION Image ##### -->
<!-- ##### MACRO GIMP_MIN_IMAGE_SIZE ##### -->
<para>
The minimum width and height of a GIMP image in pixels.
</para>
<!-- ##### MACRO GIMP_MAX_IMAGE_SIZE ##### -->
<para>
The maximum width and height of a GIMP image in pixels. This is a
somewhat arbitray value that can be used when an upper value for pixel
sizes is needed; for example to give a spin button an upper limit.
</para>
<!-- ##### MACRO GIMP_MIN_RESOLUTION ##### -->
<para>
The minimum resolution of a GIMP image in pixels per inch. This is a
somewhat arbitray value that can be used to when a lower value for a
resolution is needed. GIMP will not accept resolutions smaller than
this value.
</para>
<!-- ##### MACRO GIMP_MAX_RESOLUTION ##### -->
<para>
The maximum resolution of a GIMP image in pixels per inch. This is a
somewhat arbitray value that can be used to when an upper value for a
resolution is needed. GIMP will not accept resolutions larger than
this value.
</para>
<!-- ##### MACRO GIMP_MAX_MEMSIZE ##### -->
<para>
A large but arbitrary value that can be used when an upper limit for a
memory size (in bytes) is needed. It is smaller than %G_MAXDOUBLE since
the #GimpMemsizeEntry doesn't handle larger values.
</para>

9
devel-docs/libgimpbase/tmpl/gimpmemsize.sgml
View File

@ -2,11 +2,11 @@
gimpmemsize
<!-- ##### SECTION Short_Description ##### -->
Functions to (de)serialize a given memory size.
<!-- ##### SECTION Long_Description ##### -->
<para>
Functions to (de)serialize a given memory size.
</para>
<!-- ##### SECTION See_Also ##### -->
@ -17,6 +17,9 @@ Functions to (de)serialize a given memory size.
<!-- ##### SECTION Stability_Level ##### -->
<!-- ##### SECTION Image ##### -->
<!-- ##### FUNCTION gimp_memsize_serialize ##### -->
<para>
@ -47,7 +50,7 @@ Functions to (de)serialize a given memory size.
<!-- ##### MACRO GIMP_TYPE_MEMSIZE ##### -->
<para>
#GIMP_TYPE_MEMSIZE is a #GType derived from #G_TYPE_UINT64.
</para>

13
devel-docs/libgimpbase/tmpl/gimpparam.sgml
View File

@ -2,7 +2,7 @@
gimpparam
<!-- ##### SECTION Short_Description ##### -->
Definitions of useful #GParamFlags.
<!-- ##### SECTION Long_Description ##### -->
<para>
@ -17,30 +17,33 @@ Definitions of useful #GParamFlags.
<!-- ##### SECTION Stability_Level ##### -->
<!-- ##### SECTION Image ##### -->
<!-- ##### MACRO GIMP_PARAM_STATIC_STRINGS ##### -->
<para>
Since: GIMP 2.4
</para>
<!-- ##### MACRO GIMP_PARAM_READABLE ##### -->
<para>
Since: GIMP 2.4
</para>
<!-- ##### MACRO GIMP_PARAM_WRITABLE ##### -->
<para>
Since: GIMP 2.4
</para>
<!-- ##### MACRO GIMP_PARAM_READWRITE ##### -->
<para>
Since: GIMP 2.4
</para>

9
devel-docs/libgimpbase/tmpl/gimpparasite.sgml
View File

@ -2,23 +2,24 @@
gimpparasite
<!-- ##### SECTION Short_Description ##### -->
Arbitrary pieces of data which can be attached to various GIMP objects.
<!-- ##### SECTION Long_Description ##### -->
<para>
Arbitrary pieces of data which can be attached to various GIMP objects.
</para>
<!-- ##### SECTION See_Also ##### -->
<para>
gimp_image_parasite_attach(), gimp_drawable_parasite_attach(),
gimp_parasite_attach() and their related functions.
</para>
<!-- ##### SECTION Stability_Level ##### -->
<!-- ##### SECTION Image ##### -->
<!-- ##### STRUCT GimpParasite ##### -->
<para>

26
devel-docs/libgimpbase/tmpl/gimpparasiteio.sgml
View File

@ -2,22 +2,24 @@
gimpparasiteio
<!-- ##### SECTION Short_Description ##### -->
Utility functions to (de)serialize certain C structures to/from #GimpParasite's.
<!-- ##### SECTION Long_Description ##### -->
<para>
Utility functions to (de)serialize certain C structures to/from #GimpParasite's.
</para>
<!-- ##### SECTION See_Also ##### -->
<para>
#GimpParasite
</para>
<!-- ##### SECTION Stability_Level ##### -->
<!-- ##### SECTION Image ##### -->
<!-- ##### MACRO GIMP_PIXPIPE_MAXDIM ##### -->
<para>
@ -25,6 +27,24 @@ Utility functions to (de)serialize certain C structures to/from #GimpParasite's.
<!-- ##### STRUCT GimpPixPipeParams ##### -->
<para>
</para>
@step:
@ncells:
@dim:
@cols:
@rows:
@cellwidth:
@cellheight:
@placement:
@free_placement_string:
@rank:
@selection:
@free_selection_string:
<!-- ##### FUNCTION gimp_pixpipe_params_init ##### -->
<para>

3
devel-docs/libgimpbase/tmpl/gimprectangle.sgml
View File

@ -17,6 +17,9 @@ gimprectangle
<!-- ##### SECTION Stability_Level ##### -->
<!-- ##### SECTION Image ##### -->
<!-- ##### FUNCTION gimp_rectangle_intersect ##### -->
<para>

16
devel-docs/libgimpbase/tmpl/gimpsignal.sgml
View File

@ -2,32 +2,30 @@
gimpsignal
<!-- ##### SECTION Short_Description ##### -->
Portable signal handling.
<!-- ##### SECTION Long_Description ##### -->
<para>
Portable signal handling.
</para>
<!-- ##### SECTION See_Also ##### -->
<para>
signal(2), signal(5 or 7), sigaction(2).
</para>
<!-- ##### SECTION Stability_Level ##### -->
<!-- ##### SECTION Image ##### -->
<!-- ##### USER_FUNCTION GimpSignalHandlerFunc ##### -->
<para>
A prototype for signal handler functions. Note that each function which
takes or returns a variable of this type also accepts or may return
special values defined by your system's signal.h header file (like
@SIG_DFL or @SIG_IGN).
</para>
@signum: The number of the signal. Useful if different signals are handled
by a single handler.
@signum:
<!-- ##### FUNCTION gimp_signal_private ##### -->

39
devel-docs/libgimpbase/tmpl/gimpunit.sgml
View File

@ -2,27 +2,24 @@
gimpunit
<!-- ##### SECTION Short_Description ##### -->
Provides a collection of predefined units and functions for creating
user-defined units.
<!-- ##### SECTION Long_Description ##### -->
<para>
Provides a collection of predefined units and functions for creating
user-defined units.
</para>
<!-- ##### SECTION See_Also ##### -->
<para>
#GimpUnitMenu
</para>
<para>
#GimpSizeEntry
</para>
<!-- ##### SECTION Stability_Level ##### -->
<!-- ##### SECTION Image ##### -->
<!-- ##### ENUM GimpUnit ##### -->
<para>
@ -41,6 +38,7 @@ user-defined units.
</para>
@void:
@Returns:
@ -49,6 +47,7 @@ user-defined units.
</para>
@void:
@Returns:
@ -148,9 +147,31 @@ user-defined units.
@Returns:
<!-- ##### FUNCTION gimp_pixels_to_units ##### -->
<para>
</para>
@pixels:
@unit:
@resolution:
@Returns:
<!-- ##### FUNCTION gimp_units_to_pixels ##### -->
<para>
</para>
@value:
@unit:
@resolution:
@Returns:
<!-- ##### MACRO GIMP_TYPE_UNIT ##### -->
<para>
#GIMP_TYPE_UNIT is a #GType derived from #G_TYPE_INT.
</para>

5
devel-docs/libgimpbase/tmpl/gimputils.sgml
View File

@ -2,7 +2,7 @@
gimputils
<!-- ##### SECTION Short_Description ##### -->
Utilities of general interest
<!-- ##### SECTION Long_Description ##### -->
<para>
@ -17,6 +17,9 @@ Utilities of general interest
<!-- ##### SECTION Stability_Level ##### -->
<!-- ##### SECTION Image ##### -->
<!-- ##### FUNCTION gimp_any_to_utf8 ##### -->
<para>

10
devel-docs/libgimpbase/tmpl/gimpversion.sgml
View File

@ -2,13 +2,10 @@
gimpversion
<!-- ##### SECTION Short_Description ##### -->
Macros and constants useful for determining GIMP's version number and
capabilities.
<!-- ##### SECTION Long_Description ##### -->
<para>
Macros and constants useful for determining GIMP's version number and
capabilities.
</para>
@ -20,6 +17,9 @@ capabilities.
<!-- ##### SECTION Stability_Level ##### -->
<!-- ##### SECTION Image ##### -->
<!-- ##### MACRO GIMP_MAJOR_VERSION ##### -->
<para>
@ -50,7 +50,7 @@ capabilities.
<!-- ##### MACRO GIMP_API_VERSION ##### -->
<para>
Since: GIMP 2.2
</para>

9
libgimpbase/gimpbaseenums.h
View File

@ -20,6 +20,15 @@
#define __GIMP_BASE_ENUMS_H__
/**
* SECTION: gimpbaseenums
* @title: gimpbaseenums
* @short_description: Basic GIMP enumeration data types.
*
* Basic GIMP enumeration data types.
**/
G_BEGIN_DECLS
/* For information look into the C source or the html documentation */

23
libgimpbase/gimpbasetypes.c
View File

@ -26,6 +26,17 @@
#include "gimpbasetypes.h"
/**
* SECTION: gimpbasetypes
* @title: gimpbasetypes
* @short_description: Translation between gettext translation domain
* identifier and GType.
*
* Translation between gettext translation domain identifier and
* GType.
**/
static GQuark gimp_translation_domain_quark (void) G_GNUC_CONST;
static GQuark gimp_translation_context_quark (void) G_GNUC_CONST;
static GQuark gimp_value_descriptions_quark (void) G_GNUC_CONST;
@ -38,7 +49,7 @@ static GQuark gimp_value_descriptions_quark (void) G_GNUC_CONST;
*
* This function attaches a constant string as a gettext translation
* domain identifier to a #GType. The only purpose of this function is
* to use it when registering a #GTypeEnum with translatable value
* to use it when registering a #G_TYPE_ENUM with translatable value
* names.
*
* Since: GIMP 2.2
@ -58,7 +69,7 @@ gimp_type_set_translation_domain (GType type,
* Retrieves the gettext translation domain identifier that has been
* previously set using gimp_type_set_translation_domain(). You should
* not need to use this function directly, use gimp_enum_get_value()
* or gimp_enum_value_get_name() instead.
* or gimp_enum_value_get_desc() instead.
*
* Return value: the translation domain associated with @type
* or %NULL if no domain was set
@ -74,12 +85,12 @@ gimp_type_get_translation_domain (GType type)
/**
* gimp_type_set_translation_context:
* @type: a #GType
* @domain: a constant string that identifies a translation context or %NULL
* @type: a #GType
* @context: a constant string that identifies a translation context or %NULL
*
* This function attaches a constant string as a translation context
* to a #GType. The only purpose of this function is to use it when
* registering a #GTypeEnum with translatable value names.
* registering a #G_TYPE_ENUM with translatable value names.
*
* Since: GIMP 2.8
**/
@ -98,7 +109,7 @@ gimp_type_set_translation_context (GType type,
* Retrieves the translation context that has been previously set
* using gimp_type_set_translation_context(). You should not need to
* use this function directly, use gimp_enum_get_value() or
* gimp_enum_value_get_name() instead.
* gimp_enum_value_get_desc() instead.
*
* Return value: the translation context associated with @type
* or %NULL if no context was set

18
libgimpbase/gimpbasetypes.h
View File

@ -42,6 +42,15 @@ typedef void (* GimpDatafileLoaderFunc) (const GimpDatafileData *file_data,
gpointer user_data);
/**
* GimpEnumDesc:
* @value: An enum value.
* @value_desc: The value's description.
* @value_help: The value's help text.
*
* This structure is used to register translatable descriptions and
* help texts for enum values. See gimp_enum_set_value_descriptions().
**/
struct _GimpEnumDesc
{
gint value;
@ -49,6 +58,15 @@ struct _GimpEnumDesc
const gchar *value_help;
};
/**
* GimpFlagsDesc:
* @value: A flag value.
* @value_desc: The value's description.
* @value_help: The value's help text.
*
* This structure is used to register translatable descriptions and
* help texts for flag values. See gimp_flags_set_value_descriptions().
**/
struct _GimpFlagsDesc
{
guint value;

10
libgimpbase/gimpchecks.c
View File

@ -28,6 +28,16 @@
#include "gimpchecks.h"
/**
* SECTION: gimpchecks
* @title: gimpchecks
* @short_description: Constants and functions related to rendering
* checkerboards.
*
* Constants and functions related to rendering checkerboards.
**/
/**
* gimp_checks_get_shades:
* @type: the checkerboard type

37
libgimpbase/gimpchecks.h
View File

@ -22,15 +22,36 @@
G_BEGIN_DECLS
/* the default size of the checks which indicate transparency ...
*/
#define GIMP_CHECK_SIZE 8
#define GIMP_CHECK_SIZE_SM 4
/**
* GIMP_CHECK_SIZE:
*
* The default checkerboard size in pixels. This is configurable in
* the core but GIMP plug-ins can't access the user preference and
* should use this constant instead.
**/
#define GIMP_CHECK_SIZE 8
/* ... and their default shades
*/
#define GIMP_CHECK_DARK 0.4
#define GIMP_CHECK_LIGHT 0.6
/**
* GIMP_CHECK_SIZE_SM:
*
* The default small checkerboard size in pixels.
**/
#define GIMP_CHECK_SIZE_SM 4
/**
* GIMP_CHECK_DARK:
*
* The dark gray value for the default checkerboard pattern.
**/
#define GIMP_CHECK_DARK 0.4
/**
* GIMP_CHECK_LIGHT:
*
* The dark light value for the default checkerboard pattern.
**/
#define GIMP_CHECK_LIGHT 0.6
void gimp_checks_get_shades (GimpCheckType type,

9
libgimpbase/gimpcpuaccel.c
View File

@ -38,6 +38,15 @@
#include "gimpcpuaccel.h"
/**
* SECTION: gimpcpuaccel
* @title: gimpcpuaccel
* @short_description: Functions to query and configure CPU acceleration.
*
* Functions to query and configure CPU acceleration.
**/
static GimpCpuAccelFlags cpu_accel (void) G_GNUC_CONST;

9
libgimpbase/gimpdatafiles.c
View File

@ -42,6 +42,15 @@
#include "gimpenv.h"
/**
* SECTION: gimpdatafiles
* @title: gimpdatafiles
* @short_description: Functions to handle GIMP data files.
*
* Functions to handle GIMP data files.
**/
static inline gboolean is_script (const gchar *filename);
static inline gboolean is_hidden (const gchar *filename);

13
libgimpbase/gimpdatafiles.h
View File

@ -27,6 +27,19 @@
G_BEGIN_DECLS
/**
* GimpDatafileData:
* @filename: the data file's full path.
* @dirname: the folder the data file is is.
* @basename: the data file's basename.
* @atime: the last time the file was accessed for reading.
* @mtime: the last time the file was modified.
* @ctime: the time the file was created.
*
* This structure is passed to the #GimpDatafileLoaderFunc given to
* gimp_datafiles_read_directories() for each file encountered in the
* data path.
**/
struct _GimpDatafileData
{
const gchar *filename;

10
libgimpbase/gimpenv.c
View File

@ -65,6 +65,16 @@
#endif
/**
* SECTION: gimpenv
* @title: gimpenv
* @short_description: Functions to access the GIMP environment.
*
* A set of functions to find the locations of GIMP's data directories
* and configuration files.
**/
static gchar * gimp_env_get_dir (const gchar *gimp_env_name,
const gchar *env_dir);

57
libgimpbase/gimplimits.h
View File

@ -25,18 +25,63 @@
G_BEGIN_DECLS
/* pixel sizes
*/
/**
* SECTION: gimplimits
* @title: gimplimits
* @short_description: Boundaries of some GIMP data types and some
* global constants.
*
* Boundaries of some GIMP data types and some global constants.
**/
/**
* GIMP_MIN_IMAGE_SIZE:
*
* The minimum width and height of a GIMP image in pixels.
**/
#define GIMP_MIN_IMAGE_SIZE 1
/**
* GIMP_MAX_IMAGE_SIZE:
*
* The maximum width and height of a GIMP image in pixels. This is a
* somewhat arbitray value that can be used when an upper value for
* pixel sizes is needed; for example to give a spin button an upper
* limit.
**/
#define GIMP_MAX_IMAGE_SIZE 262144 /* 2^18 */
/* dots per inch
*/
/**
* GIMP_MIN_RESOLUTION:
*
* The minimum resolution of a GIMP image in pixels per inch. This is
* a somewhat arbitray value that can be used when a lower value for a
* resolution is needed. GIMP will not accept resolutions smaller than
* this value.
**/
#define GIMP_MIN_RESOLUTION 5e-3 /* shouldn't display as 0.000 */
/**
* GIMP_MAX_RESOLUTION:
*
* The maximum resolution of a GIMP image in pixels per inch. This is
* a somewhat arbitray value that can be used to when an upper value
* for a resolution is needed. GIMP will not accept resolutions larger
* than this value.
**/
#define GIMP_MAX_RESOLUTION 65536.0
/* memory sizes
*/
/**
* GIMP_MAX_MEMSIZE:
*
* A large but arbitrary value that can be used when an upper limit
* for a memory size (in bytes) is needed. It is smaller than
* %G_MAXDOUBLE since the #GimpMemsizeEntry doesn't handle larger
* values.
**/
#define GIMP_MAX_MEMSIZE ((guint64) 1 << 42) /* 4 terabyte;
* needs a 64bit variable
* and must be < G_MAXDOUBLE

9
libgimpbase/gimpmemsize.c
View File

@ -28,6 +28,15 @@
#include "libgimp/libgimp-intl.h"
/**
* SECTION: gimpmemsize
* @title: gimpmemsize
* @short_description: Functions to (de)serialize a given memory size.
*
* Functions to (de)serialize a given memory size.
**/
static void memsize_to_string (const GValue *src_value,
GValue *dest_value);
static void string_to_memsize (const GValue *src_value,

8
libgimpbase/gimpmemsize.h
View File

@ -22,9 +22,11 @@
G_BEGIN_DECLS
/*
* GIMP_TYPE_MEMSIZE
*/
/**
* GIMP_TYPE_MEMSIZE:
*
* #GIMP_TYPE_MEMSIZE is a #GType derived from #G_TYPE_UINT64.
**/
#define GIMP_TYPE_MEMSIZE (gimp_memsize_get_type ())
#define GIMP_VALUE_HOLDS_MEMSIZE(value) (G_TYPE_CHECK_VALUE_TYPE ((value), GIMP_TYPE_MEMSIZE))

32
libgimpbase/gimpparam.h
View File

@ -19,16 +19,46 @@
#ifndef __GIMP_PARAM_H__
#define __GIMP_PARAM_H__
/* For information look into the C source or the html documentation */
/**
* SECTION: gimpparam
* @title: gimpparam
* @short_description: Definitions of useful #GParamFlags.
*
* Definitions of useful #GParamFlags.
**/
/**
* GIMP_PARAM_STATIC_STRINGS:
*
* Since: GIMP 2.4
**/
#define GIMP_PARAM_STATIC_STRINGS (G_PARAM_STATIC_NAME | \
G_PARAM_STATIC_NICK | \
G_PARAM_STATIC_BLURB)
/**
* GIMP_PARAM_READABLE:
*
* Since: GIMP 2.4
**/
#define GIMP_PARAM_READABLE (G_PARAM_READABLE | \
GIMP_PARAM_STATIC_STRINGS)
/**
* GIMP_PARAM_WRITABLE:
*
* Since: GIMP 2.4
**/
#define GIMP_PARAM_WRITABLE (G_PARAM_WRITABLE | \
GIMP_PARAM_STATIC_STRINGS)
/**
* GIMP_PARAM_READWRITE:
*
* Since: GIMP 2.4
**/
#define GIMP_PARAM_READWRITE (G_PARAM_READWRITE | \
GIMP_PARAM_STATIC_STRINGS)

13
libgimpbase/gimpparasite.c
View File

@ -38,6 +38,19 @@
#include "gimpparasite.h"
/**
* SECTION: gimpparasite
* @title: gimpparasite
* @short_description: Arbitrary pieces of data which can be attached
* to various GIMP objects.
* @see_also: gimp_image_parasite_attach(),
* gimp_drawable_parasite_attach(), gimp_parasite_attach()
* and their related functions.
*
* Arbitrary pieces of data which can be attached to various GIMP objects.
**/
/*
* GIMP_TYPE_PARASITE
*/

12
libgimpbase/gimpparasiteio.c
View File

@ -35,6 +35,18 @@
#include "gimpparasiteio.h"
/**
* SECTION: gimpparasiteio
* @title: gimpparasiteio
* @short_description: Utility functions to (de)serialize certain C
* structures to/from #GimpParasite's.
* @see_also: #GimpParasite
*
* Utility functions to (de)serialize certain C structures to/from*
* #GimpParasite's.
**/
void
gimp_pixpipe_params_init (GimpPixPipeParams *params)
{

6
libgimpbase/gimpparasiteio.h
View File

@ -38,7 +38,9 @@ G_BEGIN_DECLS
#define GIMP_PIXPIPE_MAXDIM 4
typedef struct
typedef struct _GimpPixPipeParams GimpPixPipeParams;
struct _GimpPixPipeParams
{
gint step;
gint ncells;
@ -52,7 +54,7 @@ typedef struct
gint rank[GIMP_PIXPIPE_MAXDIM];
gchar *selection[GIMP_PIXPIPE_MAXDIM];
gboolean free_selection_string;
} GimpPixPipeParams;
};
/* Initalize with dummy values */
void gimp_pixpipe_params_init (GimpPixPipeParams *params);

9
libgimpbase/gimprectangle.c
View File

@ -25,6 +25,15 @@
#include "gimprectangle.h"
/**
* SECTION: gimprectangle
* @title: gimprectangle
* @short_description: Utility functions dealing with rectangle extents.
*
* Utility functions dealing with rectangle extents.
**/
/**
* gimp_rectangle_intersect:
* @x1: origin of first rectangle

10
libgimpbase/gimpsignal.c
View File

@ -27,6 +27,16 @@
#include "gimpsignal.h"
/**
* SECTION: gimpsignal
* @title: gimpsignal
* @short_description: Portable signal handling.
* @see_also: signal(2), signal(5 or 7), sigaction(2).
*
* Portable signal handling.
**/
/* Courtesy of Austin Donnelly 06-04-2000 to address bug #2742 */
/**

14
libgimpbase/gimpsignal.h
View File

@ -26,10 +26,16 @@ G_BEGIN_DECLS
/* For information look into the C source or the html documentation */
/* GimpSignalHandlerFunc is a reference to a (signal handler) function
* that takes a signal ID and returns void.
* signal(2) returns such references; so does gimp_signal_private.
*/
/**
* GimpSignalHandlerFunc:
* @signum: The number of the signal. Useful if different signals are
* handled by a single handler.
*
* A prototype for a reference to a signal handler functions. Note
* that each function which takes or returns a variable of this type
* also accepts or may return special values defined by your system's
* signal.h header file (like @SIG_DFL or @SIG_IGN).
**/
typedef void (* GimpSignalHandlerFunc) (gint signum);
GimpSignalHandlerFunc gimp_signal_private (gint signum,

22
libgimpbase/gimpunit.c
View File

@ -31,6 +31,18 @@
#include "gimpunit.h"
/**
* SECTION: gimpunit
* @title: gimpunit
* @short_description: Provides a collection of predefined units and
* functions for creating user-defined units.
* @see_also: #GimpUnitMenu, #GimpSizeEntry.
*
* Provides a collection of predefined units and functions for
* creating user-defined units.
**/
static void unit_to_string (const GValue *src_value,
GValue *dest_value);
static void string_to_unit (const GValue *src_value,
@ -465,7 +477,9 @@ gimp_param_spec_unit (const gchar *name,
* @unit: unit to convert to
* @resolution: resloution in DPI
*
* Returns: %pixels converted to units.
* Converts a @value specified in pixels to @unit.
*
* Returns: @pixels converted to units.
*
* Since: GIMP 2.8
**/
@ -483,10 +497,12 @@ gimp_pixels_to_units (gdouble pixels,
/**
* gimp_units_to_pixels:
* @value: value in units
* @unit: unit of %value
* @unit: unit of @value
* @resolution: resloution in DPI
*
* Returns: %value converted to pixels.
* Converts a @value specified in @unit to pixels.
*
* Returns: @value converted to pixels.
*
* Since: GIMP 2.8
**/

10
libgimpbase/gimpunit.h
View File

@ -26,9 +26,11 @@ G_BEGIN_DECLS
/* For information look into the C source or the html documentation */
/*
* GIMP_TYPE_UNIT
*/
/**
* GIMP_TYPE_UNIT:
*
* #GIMP_TYPE_UNIT is a #GType derived from #G_TYPE_INT.
**/
#define GIMP_TYPE_UNIT (gimp_unit_get_type ())
#define GIMP_VALUE_HOLDS_UNIT(value) (G_TYPE_CHECK_VALUE_TYPE ((value), GIMP_TYPE_UNIT))
@ -84,7 +86,7 @@ const gchar * gimp_unit_get_plural (GimpUnit unit);
gdouble gimp_pixels_to_units (gdouble pixels,
GimpUnit unit,
gdouble resolution);
gdouble gimp_units_to_pixels (gdouble units,
gdouble gimp_units_to_pixels (gdouble value,
GimpUnit unit,
gdouble resolution);

11
libgimpbase/gimputils.c
View File

@ -32,6 +32,15 @@
#include "libgimp/libgimp-intl.h"
/**
* SECTION: gimputils
* @title: gimputils
* @short_description: Utilities of general interest
*
* Utilities of general interest
**/
/**
* gimp_utf8_strtrim:
* @str: an UTF-8 encoded string (or %NULL)
@ -236,7 +245,7 @@ gimp_filename_to_utf8 (const gchar *filename)
* In some languages, mnemonics are handled by adding the mnemonic
* character in brackets (like "File (_F)"). This function recognizes
* this construct and removes the whole bracket construction to get
* rid of the mnemonic (see bug #157561).
* rid of the mnemonic (see bug 157561).
*
* Return value: A (possibly stripped) copy of @str which should be
* freed using g_free() when it is not needed any longer.