From 096996501b99b1a285d22229b375861dbd99eef1 Mon Sep 17 00:00:00 2001 From: Norbert Pocs Date: Thu, 29 Sep 2022 11:11:09 +0200 Subject: [PATCH] client.c: Add documentation Signed-off-by: Norbert Pocs Reviewed-by: Jakub Jelen (cherry picked from commit 85f73a9bf65d085c147545b14930d61c1bb8f2b8) --- src/client.c | 20 +++++++++++++------- 1 file changed, 13 insertions(+), 7 deletions(-) diff --git a/src/client.c b/src/client.c index a35a28e1..d3e68e98 100644 --- a/src/client.c +++ b/src/client.c @@ -314,8 +314,13 @@ static int ssh_service_request_termination(void *s) } /** - * @internal + * @addtogroup libssh_session * + * @{ + */ + +/** + * @internal * @brief Request a service from the SSH server. * * Service requests are for example: ssh-userauth, ssh-connection, etc. @@ -376,12 +381,6 @@ pending: return rc; } -/** - * @addtogroup libssh_session - * - * @{ - */ - /** * @internal * @@ -834,6 +833,13 @@ error: } } +/** + * @brief Copyright information + * + * Returns copyright information + * + * @returns SSH_STRING copyright + */ const char *ssh_copyright(void) { return SSH_STRINGIFY(LIBSSH_VERSION) " (c) 2003-2022 "