From 68fab913c68e46d8fb4de3fc010b5327f18fbbef Mon Sep 17 00:00:00 2001 From: Jehan Date: Mon, 6 Apr 2026 17:55:06 +0200 Subject: [PATCH] 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. --- libgimpbase/gimpenv.c | 26 ++++++++++++++++++++++---- 1 file changed, 22 insertions(+), 4 deletions(-) diff --git a/libgimpbase/gimpenv.c b/libgimpbase/gimpenv.c index 5b47b24604..8e7a3a4400 100644 --- a/libgimpbase/gimpenv.c +++ b/libgimpbase/gimpenv.c @@ -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) {