[X2Go-Commits] [libx2goclient] 90/132: src/x2goclient-openssh-bugs.{c, h}: move bugs documentation to implementation file to fix gtk-doc warning.

[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 04b26e6c70989ac107cec6609a536988181805eb
Author: Mihai Moldovan <ionic at ionic.de>
Date:   Sat Jul 31 12:58:06 2021 +0200

    src/x2goclient-openssh-bugs.{c,h}: move bugs documentation to implementation file to fix gtk-doc warning.
---
 src/x2goclient-openssh-bugs.c | 15 +++++++++++++++
 src/x2goclient-openssh-bugs.h | 11 ++---------
 2 files changed, 17 insertions(+), 9 deletions(-)

diff --git a/src/x2goclient-openssh-bugs.c b/src/x2goclient-openssh-bugs.c
index 5c4aa08..cfcc798 100644
--- a/src/x2goclient-openssh-bugs.c
+++ b/src/x2goclient-openssh-bugs.c
@@ -47,6 +47,21 @@
  * 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 c26ce25..97bc483 100644
--- a/src/x2goclient-openssh-bugs.h
+++ b/src/x2goclient-openssh-bugs.h
@@ -34,21 +34,14 @@
 G_BEGIN_DECLS
 
 /*
- * Bugs in OpenSSH.
- *
- * Please document each entry.
+ * Please document each entry in the implementation file
+ * (x2goclient-openssh-bugs.c).
  *
  * 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
  * want this to happen as well.
  */
 typedef struct X2GoClientOpenSSHBugs_ {
-  /*
-   * Normally, child processes should fully detach from the controlling
-   * terminal. OpenSSH is buggy in some cases and doesn't always do that.
-   *
-   * C.f., https://bugzilla.mindrot.org/show_bug.cgi?id=3137
-   */
   _Bool backgrounding_keeps_stderr : 1;
 } X2GoClientOpenSSHBugs;
 

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