From c015ecf0b7fdc8d8ceb2c9b0a9841b921016028d Mon Sep 17 00:00:00 2001 From: Philip Withnall Date: Wed, 25 Oct 2023 15:09:21 +0100 Subject: [PATCH] docs: Move the GTlsInteraction SECTION Move it to the struct docs. Signed-off-by: Philip Withnall Helps: #3037 --- gio/gtlsinteraction.c | 25 ++++++++----------------- 1 file changed, 8 insertions(+), 17 deletions(-) diff --git a/gio/gtlsinteraction.c b/gio/gtlsinteraction.c index 9b15fcc30..acafd4fe5 100644 --- a/gio/gtlsinteraction.c +++ b/gio/gtlsinteraction.c @@ -36,37 +36,28 @@ /** - * SECTION:gtlsinteraction - * @short_description: Interaction with the user during TLS operations. - * @include: gio/gio.h + * GTlsInteraction: * - * #GTlsInteraction provides a mechanism for the TLS connection and database + * `GTlsInteraction` provides a mechanism for the TLS connection and database * code to interact with the user. It can be used to ask the user for passwords. * - * To use a #GTlsInteraction with a TLS connection use - * g_tls_connection_set_interaction(). + * To use a `GTlsInteraction` with a TLS connection use + * [method@Gio.TlsConnection.set_interaction]. * * Callers should instantiate a derived class that implements the various * interaction methods to show the required dialogs. * * Callers should use the 'invoke' functions like - * g_tls_interaction_invoke_ask_password() to run interaction methods. These - * functions make sure that the interaction is invoked in the main loop + * [method@Gio.TlsInteraction.invoke_ask_password] to run interaction methods. + * These functions make sure that the interaction is invoked in the main loop * and not in the current thread, if the current thread is not running the * main loop. * - * Derived classes can choose to implement whichever interactions methods they'd + * Derived classes can choose to implement whichever interactions methods they’d * like to support by overriding those virtual methods in their class * initialization function. Any interactions not implemented will return - * %G_TLS_INTERACTION_UNHANDLED. If a derived class implements an async method, + * `G_TLS_INTERACTION_UNHANDLED`. If a derived class implements an async method, * it must also implement the corresponding finish method. - */ - -/** - * GTlsInteraction: - * - * An object representing interaction that the TLS connection and database - * might have with the user. * * Since: 2.30 */