libgimpbase: add and improve some docs.
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:
parent
abd22d0059
commit
68fab913c6
1 changed files with 22 additions and 4 deletions
|
|
@ -110,10 +110,14 @@ const guint gimp_micro_version = GIMP_MICRO_VERSION;
|
||||||
* gimp_env_init:
|
* gimp_env_init:
|
||||||
* @plug_in: must be %TRUE if this function is called from a plug-in
|
* @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 should never call this function directly. While the symbol is
|
||||||
* you automatically (by means of the [func@Gimp.MAIN] macro that every
|
* exported, the function is not declared in header and it is therefore
|
||||||
* C plug-in runs or directly with [func@Gimp.main] in binding). Calling
|
* neither considered public nor stable.
|
||||||
* it again will cause a fatal error.
|
*
|
||||||
|
* 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
|
* 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
|
void
|
||||||
gimp_env_exit (gboolean plug_in)
|
gimp_env_exit (gboolean plug_in)
|
||||||
{
|
{
|
||||||
|
|
|
||||||
Loading…
Reference in a new issue