aboutsummaryrefslogtreecommitdiff
path: root/libssh
diff options
context:
space:
mode:
authorAndreas Schneider <mail@cynapses.org>2009-05-04 10:18:42 +0000
committerAndreas Schneider <mail@cynapses.org>2009-05-04 10:18:42 +0000
commit0d17b6778bc37214abab32989773cf4ce4688348 (patch)
treedf7ab4b98bd277710e3efd71802948447dfd8dba /libssh
parent43d881ba28ac0b71ad583aebc7b82db646990b56 (diff)
downloadlibssh-0d17b6778bc37214abab32989773cf4ce4688348.tar.gz
libssh-0d17b6778bc37214abab32989773cf4ce4688348.tar.xz
libssh-0d17b6778bc37214abab32989773cf4ce4688348.zip
Reformat channel_get_session() and improve docu.
git-svn-id: svn+ssh://svn.berlios.de/svnroot/repos/libssh/trunk@703 7dcaeef0-15fb-0310-b436-a5af3365683c
Diffstat (limited to 'libssh')
-rw-r--r--libssh/channels.c13
1 files changed, 8 insertions, 5 deletions
diff --git a/libssh/channels.c b/libssh/channels.c
index 13ddc25..47e2c97 100644
--- a/libssh/channels.c
+++ b/libssh/channels.c
@@ -1622,12 +1622,15 @@ int channel_poll(CHANNEL *channel, int is_stderr){
return buffer_get_rest_len(stdbuf);
}
-/** \brief recover the session in which belong a channel
- * \param channel channel
- * \return the session pointer
+/**
+ * @brief Recover the session in which belongs a channel.
+ *
+ * @param channel The channel to recover the session from.
+ *
+ * @return The session pointer.
*/
-SSH_SESSION *channel_get_session(CHANNEL *channel){
- return channel->session;
+SSH_SESSION *channel_get_session(CHANNEL *channel) {
+ return channel->session;
}
/** \brief get the exit status of the channel (error code from the executed instruction).