From 8823dee51a95ca9d46d005f4f0a4b2c3f827a78b Mon Sep 17 00:00:00 2001
From: Andreas Schneider <asn@cryptomilk.org>
Date: Mon, 16 Sep 2013 09:11:03 +0200
Subject: client: Add example code for ssh_get_openssh_version().

BUG: https://red.libssh.org/issues/120
---
 src/client.c | 8 ++++++++
 1 file changed, 8 insertions(+)

(limited to 'src')

diff --git a/src/client.c b/src/client.c
index 99a300b1..6bab5f8b 100644
--- a/src/client.c
+++ b/src/client.c
@@ -579,6 +579,14 @@ char *ssh_get_issue_banner(ssh_session session) {
  * @param[in]  session  The SSH session to use.
  *
  * @return The version number if available, 0 otherwise.
+ *
+ * @code
+ * int openssh = ssh_get_openssh_version();
+ *
+ * if (openssh == SSH_INT_VERSION(6, 1, 0)) {
+ *     printf("Version match!\m");
+ * }
+ * @endcode
  */
 int ssh_get_openssh_version(ssh_session session) {
   if (session == NULL) {
-- 
cgit v1.2.3