dallasgroot/Gimp
dallasgroot/Gimp
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

libgimpbase: add and improve some docs.

Browse source 
This is a fixup for commit a85e5286fd.
While neither gimp_env_init() and gimp_env_exit() are supposed to be
part of the public API (therefore these docs won't be part of the
gi-docgen docs either), it's better to properly document this with
explicit text.
This commit is contained in:
Jehan 2026-04-06 17:55:06 +02:00
parent abd22d0059
commit 68fab913c6
1 changed files with 22 additions and 4 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

26
libgimpbase/gimpenv.c
View file

@ -110,10 +110,14 @@ const guint gimp_micro_version = GIMP_MICRO_VERSION;
* gimp_env_init:
* @plug_in: must be %TRUE if this function is called from a plug-in
*
* You don't need to care about this function. It is being called for
* you automatically (by means of the [func@Gimp.MAIN] macro that every
* C plug-in runs or directly with [func@Gimp.main] in binding). Calling
* it again will cause a fatal error.
* You should never call this function directly. While the symbol is
* exported, the function is not declared in header and it is therefore
* neither considered public nor stable.
*
* It is being called for you automatically (by means of the
* [func@Gimp.MAIN] macro that every C plug-in runs or directly with
* [func@Gimp.main] in binding). Calling it again will cause a fatal
* error.
*
* Since: 2.4
*/
@ -174,6 +178,20 @@ gimp_env_init (gboolean plug_in)
}
}
/**
* gimp_env_exit:
* @plug_in: must be %TRUE if this function is called from a plug-in
*
* You should never call this function directly. While the symbol is
* exported, the function is not declared in header and it is therefore
* neither considered public nor stable.
*
* It is being called for you automatically (by means of the
* [func@Gimp.MAIN] macro that every C plug-in runs or directly with
* [func@Gimp.main] in binding).
*
* Since: 3.2.2
*/
void
gimp_env_exit (gboolean plug_in)
{