summaryrefslogtreecommitdiffstats
path: root/libssh/socket.c
diff options
context:
space:
mode:
authorAris Adamantiadis <aris@0xbadc0de.be>2009-12-09 19:53:58 +0100
committerAris Adamantiadis <aris@0xbadc0de.be>2009-12-09 19:53:58 +0100
commitab52ca01add461ccd2f67a5b78a62cc2a0dc2b37 (patch)
treed080496193828b0cf487dffe19ad7f186b1b6312 /libssh/socket.c
parent64b72f8d3a5165e02e19a302a85cc196698edcfa (diff)
downloadlibssh-ab52ca01add461ccd2f67a5b78a62cc2a0dc2b37.tar.gz
libssh-ab52ca01add461ccd2f67a5b78a62cc2a0dc2b37.tar.xz
libssh-ab52ca01add461ccd2f67a5b78a62cc2a0dc2b37.zip
Resolving doxygen errors in internal mode
Diffstat (limited to 'libssh/socket.c')
-rw-r--r--libssh/socket.c20
1 files changed, 11 insertions, 9 deletions
diff --git a/libssh/socket.c b/libssh/socket.c
index a1a0e2c..d5df4c3 100644
--- a/libssh/socket.c
+++ b/libssh/socket.c
@@ -123,8 +123,9 @@ ssh_socket ssh_socket_new(ssh_session session) {
/**
* @internal
* @brief the socket callbacks, i.e. callbacks to be called
- * upon a socket event
- * @param callbacks a ssh_socket_callback object reference
+ * upon a socket event.
+ * @param s socket to set callbacks on.
+ * @param callbacks a ssh_socket_callback object reference.
*/
void ssh_socket_set_callbacks(ssh_socket s, ssh_socket_callbacks callbacks){
@@ -770,14 +771,15 @@ int ssh_socket_get_status(ssh_socket s) {
* @internal
* @brief Launches a socket connection
* If a the socket connected callback has been defined and
- * a poll object exists, this call will be non blocking
- * @param host hostname or ip address to connect to
- * @param port port number to connect to
- * @param bind_addr address to bind to, or NULL for default
- * @returns SSH_OK socket is being connected
- * @returns SSH_ERROR error while connecting to remote host
+ * a poll object exists, this call will be non blocking.
+ * @param s socket to connect.
+ * @param host hostname or ip address to connect to.
+ * @param port port number to connect to.
+ * @param bind_addr address to bind to, or NULL for default.
+ * @returns SSH_OK socket is being connected.
+ * @returns SSH_ERROR error while connecting to remote host.
* @bug It only tries connecting to one of the available AI's
- * which is problematic for hosts having DNS fail-over
+ * which is problematic for hosts having DNS fail-over.
*/
int ssh_socket_connect(ssh_socket s, const char *host, int port, const char *bind_addr){