eUgEntOptIc44/gimp
1
1
Fork 0
mirror of https://gitlab.gnome.org/GNOME/gimp.git synced 2025-10-06 01:12:40 +02:00
Code Issues Releases Activity

libgimpbase: improve parasite API documentation

Browse Source
This commit is contained in:
Jacob Boerema
2023-05-27 17:20:12 -04:00
parent 24ca35625b
commit 640fb89f13
2 changed files with 23 additions and 4 deletions
Download Patch File Download Diff File Expand all files Collapse all files

5
libgimpbase/gimpparasite.c
View File

@@ -207,7 +207,8 @@ gimp_parasite_print (GimpParasite *parasite)
/** /**
* gimp_parasite_new: * gimp_parasite_new:
* @name: the new #GimpParasite name. * @name: the new #GimpParasite name.
* @flags: see libgimpbase/gimpparasite.h macros. * @flags: see [const@Gimp.PARASITE_PERSISTENT] and [const@Gimp.PARASITE_UNDOABLE];
* other values are mainly intended for internal use.
* @size: the size of @data, including a terminal %NULL byte if needed. * @size: the size of @data, including a terminal %NULL byte if needed.
* @data: (nullable) (array length=size) (element-type char): the data to save in a parasite. * @data: (nullable) (array length=size) (element-type char): the data to save in a parasite.
* *
@@ -330,6 +331,8 @@ gimp_parasite_compare (const GimpParasite *a,
* gimp_parasite_get_flags: * gimp_parasite_get_flags:
* @parasite: a #GimpParasite * @parasite: a #GimpParasite
* *
* Get the flags of the parasite.
*
* Returns: @parasite flags. * Returns: @parasite flags.
*/ */
gulong gulong

22
libgimpbase/gimpparasite.h
View File

@@ -55,8 +55,23 @@ GParamSpec * gimp_param_spec_parasite (const gchar *name,
const gchar *blurb, const gchar *blurb,
GParamFlags flags); GParamFlags flags);
/**
* GIMP_PARASITE_PERSISTENT:
*
* A persistent parasite will be saved to XCF and can be used again after
* reloading. A non persistent parasite will only be available during the
* current session.
* See [struct@Gimp.Parasite].
**/
#define GIMP_PARASITE_PERSISTENT 1 #define GIMP_PARASITE_PERSISTENT 1
/**
* GIMP_PARASITE_UNDOABLE:
*
* An undoable parasite that was added, can be removed using the Undo action.
* If this flag is not set, undoing will not change the parasite.
* See [struct@Gimp.Parasite].
**/
#define GIMP_PARASITE_UNDOABLE 2 #define GIMP_PARASITE_UNDOABLE 2
#define GIMP_PARASITE_ATTACH_PARENT (0x80 << 8) #define GIMP_PARASITE_ATTACH_PARENT (0x80 << 8)
@@ -71,9 +86,10 @@ GParamSpec * gimp_param_spec_parasite (const gchar *name,
/** /**
* GimpParasite: * GimpParasite:
* @name: the parasite name, USE A UNIQUE PREFIX * @name: the parasite name, USE A UNIQUE PREFIX
* @flags: the parasite flags, like save in XCF etc. * @flags: the parasite flags, see [const@Gimp.PARASITE_PERSISTENT] and
* [const@Gimp.PARASITE_UNDOABLE]
* @size: the parasite size in bytes * @size: the parasite size in bytes
* @data: (array length=size): the parasite data, the owner os the parasite is responsible * @data: (array length=size): the parasite data, the owner of the parasite is responsible
* for tracking byte order and internal structure * for tracking byte order and internal structure
**/ **/
struct _GimpParasite struct _GimpParasite