mirror of
https://gitlab.gnome.org/GNOME/gimp.git
synced 2025-10-05 21:02:42 +02:00
libgimpbase: improve parasite API documentation
This commit is contained in:
@@ -207,7 +207,8 @@ gimp_parasite_print (GimpParasite *parasite)
|
||||
/**
|
||||
* gimp_parasite_new:
|
||||
* @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.
|
||||
* @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:
|
||||
* @parasite: a #GimpParasite
|
||||
*
|
||||
* Get the flags of the parasite.
|
||||
*
|
||||
* Returns: @parasite flags.
|
||||
*/
|
||||
gulong
|
||||
|
@@ -55,8 +55,23 @@ GParamSpec * gimp_param_spec_parasite (const gchar *name,
|
||||
const gchar *blurb,
|
||||
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
|
||||
|
||||
/**
|
||||
* 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_ATTACH_PARENT (0x80 << 8)
|
||||
@@ -71,9 +86,10 @@ GParamSpec * gimp_param_spec_parasite (const gchar *name,
|
||||
/**
|
||||
* GimpParasite:
|
||||
* @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
|
||||
* @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
|
||||
**/
|
||||
struct _GimpParasite
|
||||
|
Reference in New Issue
Block a user