From adf23533e02d997118d1732f91abf9f116a47cec Mon Sep 17 00:00:00 2001
From: Andreas Schneider <asn@cryptomilk.org>
Date: Wed, 9 Apr 2014 15:01:25 +0200
Subject: doc: Improve docs for ssh_channel_get_exit_status().

BUG: https://red.libssh.org/issues/154
---
 src/channels.c | 5 +++++
 1 file changed, 5 insertions(+)

(limited to 'src/channels.c')

diff --git a/src/channels.c b/src/channels.c
index e38d9141..dd91bae1 100644
--- a/src/channels.c
+++ b/src/channels.c
@@ -3060,6 +3060,11 @@ static int ssh_channel_exit_status_termination(void *c){
  *                      (yet).
  * @warning             This function may block until a timeout (or never)
  *                      if the other side is not willing to close the channel.
+ *
+ * If you're looking for an async handling of this register a callback for the
+ * exit status.
+ *
+ * @see ssh_channel_exit_status_callback
  */
 int ssh_channel_get_exit_status(ssh_channel channel) {
   int rc;
-- 
cgit