docs: Move the GDebugController SECTION

Move the contents to the struct docs.

Signed-off-by: Philip Withnall <philip@tecnocode.co.uk>

Helps: #3037
This commit is contained in:
Philip Withnall 2023-10-23 00:38:12 +01:00
parent bd5219a0c0
commit 71ff617159
2 changed files with 9 additions and 19 deletions

View File

@ -29,25 +29,23 @@
#include "giomodule-priv.h"
/**
* SECTION:gdebugcontroller
* @title: GDebugController
* @short_description: Debugging controller
* @include: gio/gio.h
* GDebugController:
*
* #GDebugController is an interface to expose control of debugging features and
* `GDebugController` is an interface to expose control of debugging features and
* debug output.
*
* It is implemented on Linux using #GDebugControllerDBus, which exposes a D-Bus
* interface to allow authenticated peers to control debug features in this
* process.
* It is implemented on Linux using [class@Gio.DebugControllerDBus], which
* exposes a D-Bus interface to allow authenticated peers to control debug
* features in this process.
*
* Whether debug output is enabled is exposed as
* #GDebugController:debug-enabled. This controls g_log_set_debug_enabled() by
* default. Application code may connect to the #GObject::notify signal for it
* [property@Gio.DebugController:debug-enabled]. This controls
* [func@GLib.log_set_debug_enabled] by default. Application code may
* connect to the [signal@GObject.Object::notify] signal for it
* to control other parts of its debug infrastructure as necessary.
*
* If your application or service is using the default GLib log writer function,
* creating one of the built-in implementations of #GDebugController should be
* creating one of the built-in implementations of `GDebugController` should be
* all thats needed to dynamically enable or disable debug output.
*
* Since: 2.72

View File

@ -41,14 +41,6 @@ G_BEGIN_DECLS
*/
#define G_DEBUG_CONTROLLER_EXTENSION_POINT_NAME "gio-debug-controller"
/**
* GDebugController:
*
* #GDebugController is an interface to expose control of debugging features and
* debug output.
*
* Since: 2.72
*/
#define G_TYPE_DEBUG_CONTROLLER (g_debug_controller_get_type ())
GIO_AVAILABLE_IN_2_72
G_DECLARE_INTERFACE(GDebugController, g_debug_controller, g, debug_controller, GObject)