[X2Go-Commits] [libx2goclient] 31/132: src/x2goclient-openssh-version.h: document error enum.

[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 2f9d33067903b9b4f617ba4cf148c4a58abed16a
Author: Mihai Moldovan <ionic at ionic.de>
Date:   Wed Mar 17 21:32:22 2021 +0100

    src/x2goclient-openssh-version.h: document error enum.
---
 src/x2goclient-openssh-version.h | 100 +++++++++++++++++++++++++++++++++++++++
 1 file changed, 100 insertions(+)

diff --git a/src/x2goclient-openssh-version.h b/src/x2goclient-openssh-version.h
index 21b23ee..9e21cf2 100644
--- a/src/x2goclient-openssh-version.h
+++ b/src/x2goclient-openssh-version.h
@@ -52,6 +52,106 @@ void x2goclient_openssh_version_free (X2GoClientOpenSSHVersion * const openssh_v
  */
 #define X2GOCLIENT_OPENSSH_VERSION_ERROR g_quark_from_static_string ("x2goclient-openssh-version")
 
+/**
+ * X2GoClientOpenSSHVersionErrors:
+ * @X2GOCLIENT_OPENSSH_VERSION_ERROR_INVALID_STRUCT: no
+ *                                                   X2GoClientOpenSSHVersion
+ *                                                   structure passed.
+ * @X2GOCLIENT_OPENSSH_VERSION_ERROR_INVALID_VERSION_STRING: no version string
+ *                                                           to extract
+ *                                                           information from
+ *                                                           passed.
+ * @X2GOCLIENT_OPENSSH_VERSION_ERROR_INVALID_PREAMBLE: version string does not
+ *                                                     begin with "OpenSSH_".
+ * @X2GOCLIENT_OPENSSH_VERSION_ERROR_NO_MAJOR_SEPARATOR: no dot found
+ *                                                       separating the major
+ *                                                       version number from
+ *                                                       the minor version
+ *                                                       number.
+ * @X2GOCLIENT_OPENSSH_VERSION_ERROR_NO_MINOR_SEPARATOR: no dot found
+ *                                                       separating the minor
+ *                                                       version number from
+ *                                                       the patch version
+ *                                                       number.
+ * @X2GOCLIENT_OPENSSH_VERSION_ERROR_NOT_AT_MAJOR_SEPARATOR: version parsing
+ *                                                           stopped after
+ *                                                           major version at
+ *                                                           a non-dot-non,
+ *                                                           non-numeric
+ *                                                           character.
+ * @X2GOCLIENT_OPENSSH_VERSION_ERROR_NOT_AT_MINOR_SEPARATOR: version parsing
+ *                                                           stopped after
+ *                                                           minor version at
+ *                                                           a non-dot-non,
+ *                                                           non-numeric
+ *                                                           character.
+ * @X2GOCLIENT_OPENSSH_VERSION_ERROR_MAJOR_NOT_NUMERIC: major version number
+ *                                                      to parse was not
+ *                                                      numeric.
+ * @X2GOCLIENT_OPENSSH_VERSION_ERROR_MAJOR_UNDERFLOW: major version number to
+ *                                                    parse too small to fit
+ *                                                    into #long long
+ *                                                    type.
+ * @X2GOCLIENT_OPENSSH_VERSION_ERROR_MAJOR_OVERFLOW: major version number to
+ *                                                   parse too big to fit
+ *                                                   into #long long
+ *                                                   type.
+ * @X2GOCLIENT_OPENSSH_VERSION_ERROR_MAJOR_TOO_BIG: major version number to
+ *                                                  parse was bigger than
+ *                                                  the maximum 32-bit
+ *                                                  unsigned integer value.
+ * @X2GOCLIENT_OPENSSH_VERSION_ERROR_MAJOR_NEGATIVE: major version number to
+ *                                                   parse was negative.
+ * @X2GOCLIENT_OPENSSH_VERSION_ERROR_MINOR_NOT_NUMERIC: minor version number
+ *                                                      to parse was not
+ *                                                      numeric.
+ * @X2GOCLIENT_OPENSSH_VERSION_ERROR_MINOR_UNDERFLOW: minor version number to
+ *                                                    parse too small to fit
+ *                                                    into #long long
+ *                                                    type.
+ * @X2GOCLIENT_OPENSSH_VERSION_ERROR_MINOR_OVERFLOW: minor version number to
+ *                                                   parse too big to fit
+ *                                                   into #long long
+ *                                                   type.
+ * @X2GOCLIENT_OPENSSH_VERSION_ERROR_MINOR_TOO_BIG: minor version number to
+ *                                                  parse was bigger than
+ *                                                  the maximum 32-bit
+ *                                                  unsigned integer value.
+ * @X2GOCLIENT_OPENSSH_VERSION_ERROR_MINOR_NEGATIVE: minor version number to
+ *                                                   parse was negative.
+ * @X2GOCLIENT_OPENSSH_VERSION_ERROR_PATCH_NOT_NUMERIC: patch version number
+ *                                                      to parse was not
+ *                                                      numeric.
+ * @X2GOCLIENT_OPENSSH_VERSION_ERROR_PATCH_UNDERFLOW: patch version number to
+ *                                                    parse too small to fit
+ *                                                    into #long long
+ *                                                    type.
+ * @X2GOCLIENT_OPENSSH_VERSION_ERROR_PATCH_OVERFLOW: patch version number to
+ *                                                   parse too big to fit
+ *                                                   into #long long
+ *                                                   type.
+ * @X2GOCLIENT_OPENSSH_VERSION_ERROR_PATCH_TOO_BIG: patch version number to
+ *                                                  parse was bigger than
+ *                                                  the maximum 32-bit
+ *                                                  unsigned integer value.
+ * @X2GOCLIENT_OPENSSH_VERSION_ERROR_PATCH_NEGATIVE: patch version number to
+ *                                                   parse was negative.
+ * @X2GOCLIENT_OPENSSH_VERSION_ERROR_OPENSSH_VERSION_NO_STDERR: OpenSSH client
+ *                                                              did not write
+ *                                                              its version
+ *                                                              number to
+ *                                                              stderr.
+ * @X2GOCLIENT_OPENSSH_VERSION_ERROR_OPENSSH_VERSION_ALLOCATE: buffer for
+ *                                                             OpenSSH version
+ *                                                             structure could
+ *                                                             not be
+ *                                                             allocated.
+ *
+ * Error message types as used within X2GoClientOpenSSHVersion. May be passed
+ * out via #GError instances.
+ *
+ * Since: 0.0.5
+ */
 enum X2GoClientOpenSSHVersionErrors {
   X2GOCLIENT_OPENSSH_VERSION_ERROR_INVALID_STRUCT = 0,
   X2GOCLIENT_OPENSSH_VERSION_ERROR_INVALID_VERSION_STRING,

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