This is an automated email from the git hooks/post-receive script. x2go pushed a commit to branch master in repository libx2goclient. commit 7a9d3995edd5cd5bfdfb8b86f0c99d5035ceb21b Author: Mihai Moldovan <ionic@ionic.de> Date: Fri Dec 3 13:03:37 2021 +0100 src/x2goclient-{network-{ssh,stub},openssh-{bugs,version}}.c: add missing documentation. --- src/x2goclient-network-ssh.c | 15 +++++++++++++++ src/x2goclient-network-stub.c | 13 +++++++++++++ src/x2goclient-openssh-bugs.c | 34 ++++++++++++++++++++++++++++++++++ src/x2goclient-openssh-version.c | 34 ++++++++++++++++++++++++++++++++++ 4 files changed, 96 insertions(+) diff --git a/src/x2goclient-network-ssh.c b/src/x2goclient-network-ssh.c index badb642..8c11e7f 100644 --- a/src/x2goclient-network-ssh.c +++ b/src/x2goclient-network-ssh.c @@ -265,6 +265,21 @@ static void x2goclient_network_ssh_init (X2GoClientNetworkSSH * const self) { self->check_thread_loop = NULL; } +/** + * x2goclient_network_ssh_new: + * @session_path: (in) (transfer none): the session path root to be used for + * temporary session data. + * + * Creates a new #X2GoClientNetworkSSH instance, rooted at the path indicated + * by @session_path. + * + * No connection is being established by just creating such an object, which + * is also showcased by it not taking a remote location. + * + * Returns: (transfer full): the new #X2GoClientNetworkSSH instance + * + * Since: 0.0.0 + */ X2GoClientNetworkSSH* x2goclient_network_ssh_new (const char * const session_path) { X2GoClientNetworkSSH *ret = NULL; diff --git a/src/x2goclient-network-stub.c b/src/x2goclient-network-stub.c index b947df4..5e35eed 100644 --- a/src/x2goclient-network-stub.c +++ b/src/x2goclient-network-stub.c @@ -88,6 +88,19 @@ static void x2goclient_network_stub_init (X2GoClientNetworkStub * const self) { (void) self; } +/** + * x2goclient_network_stub_new: + * + * Creates a new #X2GoClientNetworkStub instance, with everything initialized + * to the default value. + * + * No connection is being established by just creating such an object, which + * is also showcased by it not taking a remote location. + * + * Returns: (transfer full): the new #X2GoClientNetworkStub instance + * + * Since: 0.0.0 + */ X2GoClientNetworkStub* x2goclient_network_stub_new (void) { X2GoClientNetworkStub *ret = NULL; diff --git a/src/x2goclient-openssh-bugs.c b/src/x2goclient-openssh-bugs.c index a0e9df3..9b722d0 100644 --- a/src/x2goclient-openssh-bugs.c +++ b/src/x2goclient-openssh-bugs.c @@ -48,14 +48,48 @@ * Since: 0.0.0 */ +/** + * x2goclient_openssh_bugs_new: + * + * Creates a new #X2GoClientOpenSSHBugs instance with all quirks + * disabled by default. + * + * Returns: (transfer full): the new #X2GoClientOpenSSHBugs instance + * + * Since: 0.0.0 + */ X2GoClientOpenSSHBugs* x2goclient_openssh_bugs_new (void) { return (g_slice_new0 (X2GoClientOpenSSHBugs)); } +/** + * x2goclient_openssh_bugs_free: + * @openssh_bugs: (in) (nullable) (transfer full): + * a pointer to an #X2GoClientOpenSSHBugs instance. + * + * Deletes memory allocated for the #X2GoClientOpenSSHBugs instance. + * + * While a %NULL input is supported, avoid that, since it will essentially + * degrade into a no-op with additional overhead. + * + * Since: 0.0.0 + */ void x2goclient_openssh_bugs_free (X2GoClientOpenSSHBugs * const openssh_bugs) { g_slice_free (X2GoClientOpenSSHBugs, openssh_bugs); } +/** + * x2goclient_openssh_bugs_copy: + * @openssh_bugs: (in) (not nullable) (transfer none): + * a pointer to an #X2GoClientOpenSSHBugs instance. + * + * Copies an #X2GoClientOpenSSHBugs instance. + * + * Returns: (transfer full): a new #X2GoClientOpenSSHBugs instance with the + * same internal data on success, %NULL on error + * + * Since: 0.0.0 + */ static X2GoClientOpenSSHBugs* x2goclient_openssh_bugs_copy (const X2GoClientOpenSSHBugs * const src) { X2GoClientOpenSSHBugs *dst = NULL; diff --git a/src/x2goclient-openssh-version.c b/src/x2goclient-openssh-version.c index c25636e..5d94413 100644 --- a/src/x2goclient-openssh-version.c +++ b/src/x2goclient-openssh-version.c @@ -52,14 +52,48 @@ * Since: 0.0.0 */ +/** + * x2goclient_openssh_version_new: + * + * Creates a new #X2GoClientOpenSSHVersion instance with every member + * initialized to the default value. + * + * Returns: (transfer full): the new #X2GoClientOpenSSHVersion instance + * + * Since: 0.0.0 + */ X2GoClientOpenSSHVersion* x2goclient_openssh_version_new (void) { return (g_slice_new0 (X2GoClientOpenSSHVersion)); } +/** + * x2goclient_openssh_version_free: + * @openssh_version: (in) (nullable) (transfer full): + * a pointer to an #X2GoClientOpenSSHVersion instance. + * + * Deletes memory allocated for the #X2GoClientOpenSSHVersion instance. + * + * While a %NULL input is supported, avoid that, since it will essentially + * degrade into a no-op with additional overhead. + * + * Since: 0.0.0 + */ void x2goclient_openssh_version_free (X2GoClientOpenSSHVersion * const openssh_version) { g_slice_free (X2GoClientOpenSSHVersion, openssh_version); } +/** + * x2goclient_openssh_version_copy: + * @openssh_version: (in) (not nullable) (transfer none): + * a pointer to an #X2GoClientOpenSSHVersion instance. + * + * Copies an #X2GoClientOpenSSHVersion instance. + * + * Returns: (transfer full): a new #X2GoClientOpenSSHVersion instance with the + * same internal data on success, %NULL on error + * + * Since: 0.0.0 + */ static X2GoClientOpenSSHVersion* x2goclient_openssh_version_copy (const X2GoClientOpenSSHVersion * const src) { X2GoClientOpenSSHVersion *dst = NULL; -- Alioth's /home/x2go-admin/maintenancescripts/git/hooks/post-receive-email on /srv/git/code.x2go.org/libx2goclient.git