This is an automated email from the git hooks/post-receive script. x2go pushed a commit to branch master in repository libx2goclient. commit ecd13118cd23b05285950fc208d17c298fab9dfe Author: Mihai Moldovan <ionic@ionic.de> Date: Mon Mar 15 23:20:21 2021 +0100 src/x2goclient-openssh-bugs.c: document full class. --- src/x2goclient-openssh-bugs.c | 32 ++++++++++++++++++++++++++++++++ 1 file changed, 32 insertions(+) diff --git a/src/x2goclient-openssh-bugs.c b/src/x2goclient-openssh-bugs.c index 9328f0e..73b289f 100644 --- a/src/x2goclient-openssh-bugs.c +++ b/src/x2goclient-openssh-bugs.c @@ -31,6 +31,22 @@ #include "x2goclient-openssh-bugs.h" #include "x2goclient-openssh-version.h" +/** + * SECTION:X2GoClientOpenSSHBugs + * @short_description: Class encapsulating OpenSSH client bug definitions + * @stability: Unstable + * @include: libx2goclient/x2goclient-openssh-bugs.h + * + * #X2GoClientOpenSSHBugs is a class used to handle OpenSSH client bug + * definitions. + * + * It provides a general structure for known OpenSSH client bugs that might + * influence the behavior of this library (and, if needed, can also be + * extended to other known bugs influencing applications using this library). + * + * Since: 0.0.5 + */ + X2GoClientOpenSSHBugs* x2goclient_openssh_bugs_new (void) { return (g_slice_new0 (X2GoClientOpenSSHBugs)); } @@ -53,6 +69,22 @@ static X2GoClientOpenSSHBugs* x2goclient_openssh_bugs_copy (const X2GoClientOpen G_DEFINE_BOXED_TYPE (X2GoClientOpenSSHBugs, x2goclient_openssh_bugs, &x2goclient_openssh_bugs_copy, &x2goclient_openssh_bugs_free) +/** + * x2goclient_openssh_bugs_update: + * @self: (in) (not optional): pointer to the #X2GoClientOpenSSHBugs instance. + * @version: (in) (not optional): pointer to an #X2GoClientOpenSSHVersion + * structure acting as the base to extract bug + * information from. + * @gerr: (out) (nullable): a return location for a #GError, pass %NULL if not + * interested. + * + * Updates the bugs structure passed as @self according to the OpenSSH client + * version passed as @version. + * + * Returns: a #gboolean value indicating success (%TRUE) or failure (%FALSE). + * + * Since: 0.0.5 + */ gboolean x2goclient_openssh_bugs_update (X2GoClientOpenSSHBugs * const self, const X2GoClientOpenSSHVersion * const version, GError ** const gerr) { gboolean ret = FALSE; -- Alioth's /home/x2go-admin/maintenancescripts/git/hooks/post-receive-email on /srv/git/code.x2go.org/libx2goclient.git