summaryrefslogtreecommitdiffstats
path: root/libssh
diff options
context:
space:
mode:
authorAndreas Schneider <mail@cynapses.org>2009-05-02 20:24:39 +0000
committerAndreas Schneider <mail@cynapses.org>2009-05-02 20:24:39 +0000
commit0b4159d1ec578efeb73d925ce134eb1de3bf1a78 (patch)
treef51a2a9cd5673be575d26cc4f50bcbff2511286b /libssh
parent015b1649b1a9e9d80336409066e5085584206e78 (diff)
downloadlibssh-0b4159d1ec578efeb73d925ce134eb1de3bf1a78.tar.gz
libssh-0b4159d1ec578efeb73d925ce134eb1de3bf1a78.tar.xz
libssh-0b4159d1ec578efeb73d925ce134eb1de3bf1a78.zip
Fix the documentation.
git-svn-id: svn+ssh://svn.berlios.de/svnroot/repos/libssh/trunk@671 7dcaeef0-15fb-0310-b436-a5af3365683c
Diffstat (limited to 'libssh')
-rw-r--r--libssh/channels.c26
1 files changed, 17 insertions, 9 deletions
diff --git a/libssh/channels.c b/libssh/channels.c
index c609a92..f58a232 100644
--- a/libssh/channels.c
+++ b/libssh/channels.c
@@ -36,16 +36,22 @@
#define WINDOWBASE 128000
#define WINDOWLIMIT (WINDOWBASE/2)
-/** \defgroup ssh_channel SSH Channels
- * \brief functions that manage a channel
+/**
+ * @defgroup ssh_channel SSH Channels
+ * @brief Functions that manage a channel.
*/
-/** \addtogroup ssh_channel
- * @{ */
+/**
+ * @addtogroup ssh_channel
+ * @{
+ */
-/** \brief allocate a new channel
- * \param session ssh session
- * \return An allocated channel, NULL on error.
+/**
+ * @brief Allocate a new channel.
+ *
+ * @param session The ssh session to use.
+ *
+ * @return A pointer to a newly allocated channel, NULL on error.
*/
CHANNEL *channel_new(SSH_SESSION *session) {
CHANNEL *channel = NULL;
@@ -1342,8 +1348,10 @@ SSH_SESSION *channel_get_session(CHANNEL *channel){
* \return other values : exit status
*/
-int channel_get_exit_status(CHANNEL *channel){
- return channel->exit_status;
+int channel_get_exit_status(CHANNEL *channel) {
+ channel_request(channel, "exit-status", NULL, 0);
+
+ return channel->exit_status;
}
/* This function acts as a meta select. */