[X2Go-Commits] [libx2goclient] 112/132: src/x2goclient-openssh-bugs.{c, h}: move structure documentation back to header file.

[git-admin at x2go.org]

This is an automated email from the git hooks/post-receive script.

x2go pushed a commit to branch master
in repository libx2goclient.

commit 0b3c5e4aeb8106e9230937f34ba3f01b192d1290
Author: Mihai Moldovan <ionic at ionic.de>
Date:   Sat Oct 30 18:35:31 2021 +0200

    src/x2goclient-openssh-bugs.{c,h}: move structure documentation back to header file.
    
    The structure will only be listed in the documentation if the
    documentation is part of header files, since structures are shown or
    hidden as part of running gtkdoc-scan and this program only looks at
    such files.
    
    Importantly, a structure with the same name as the class (i.e., an
    instance structure) is hidden by default, unless documentation for it
    exists. Documentation within source/implementation files are only parsed
    by gtkdoc-mkdb, though, which is executed at a later stage.
---
 src/x2goclient-openssh-bugs.c | 15 ---------------
 src/x2goclient-openssh-bugs.h | 15 +++++++++++++--
 2 files changed, 13 insertions(+), 17 deletions(-)

diff --git a/src/x2goclient-openssh-bugs.c b/src/x2goclient-openssh-bugs.c
index 9456137..17b858b 100644
--- a/src/x2goclient-openssh-bugs.c
+++ b/src/x2goclient-openssh-bugs.c
@@ -48,21 +48,6 @@
  * Since: 0.0.0
  */
 
-/**
- * X2GoClientOpenSSHBugs:
- * @backgrounding_keeps_stderr: Normally, child processes should fully detach
- *                              from the controlling terminal. OpenSSH is
- *                              buggy in some cases and doesn't always do that.
- *                              See
- *                              <ulink
- *                                 url="https://bugzilla.mindrot.org/show_bug.cgi?id=3137">
- *                                OpenSSH Bug 3137</ulink>.
- *
- * Bugs in OpenSSH.
- *
- * Since: 0.0.0
- */
-
 X2GoClientOpenSSHBugs* x2goclient_openssh_bugs_new (void) {
   return (g_slice_new0 (X2GoClientOpenSSHBugs));
 }
diff --git a/src/x2goclient-openssh-bugs.h b/src/x2goclient-openssh-bugs.h
index 97bc483..ad4c50a 100644
--- a/src/x2goclient-openssh-bugs.h
+++ b/src/x2goclient-openssh-bugs.h
@@ -33,9 +33,20 @@
 
 G_BEGIN_DECLS
 
+/**
+ * X2GoClientOpenSSHBugs:
+ * @backgrounding_keeps_stderr: Normally, child processes should fully detach
+ *                              from the controlling terminal. OpenSSH is
+ *                              buggy in some cases and doesn't always do that.
+ *                              See
+ *                              <ulink
+ *                                 url="https://bugzilla.mindrot.org/show_bug.cgi?id=3137">
+ *                                OpenSSH Bug 3137</ulink>.
+ *
+ * Since: 0.0.0
+ */
 /*
- * Please document each entry in the implementation file
- * (x2goclient-openssh-bugs.c).
+ * Please document each entry here.
  *
  * OpenSSH doesn't do that internally, which is a pain because bug semantics
  * must be inferred from the code locations the constants are used in. We don't

--
Alioth's /home/x2go-admin/maintenancescripts/git/hooks/post-receive-email on /srv/git/code.x2go.org/libx2goclient.git