From 29a229724bebaf1947a80a3dca252206232a0643 Mon Sep 17 00:00:00 2001
From: Aris Adamantiadis <aris@0xbadc0de.be>
Date: Sat, 28 Aug 2010 21:05:24 +0200
Subject: Fix a few documentation issues

---
 libssh/keyfiles.c | 21 ++++++++++-----------
 libssh/server.c   |  3 ++-
 2 files changed, 12 insertions(+), 12 deletions(-)

(limited to 'libssh')

diff --git a/libssh/keyfiles.c b/libssh/keyfiles.c
index f715d25..f50afa7 100644
--- a/libssh/keyfiles.c
+++ b/libssh/keyfiles.c
@@ -646,21 +646,18 @@ static int privatekey_type_from_file(FILE *fp) {
 /**
  * @brief Reads a SSH private key from a file.
  *
- * @param[in]  session  The SSH Session to use.
+ * @param[in] session  The SSH Session to use.
  *
- * @param[in]  filename The filename of the the private key.
+ * @param[in] filename The filename of the the private key.
  *
- * @param[in]  type     The type of the private key. This could be SSH_KEYTYPE_DSS or
- *                      SSH_KEYTYPE_RSA. Pass 0 to automatically detect the type.
+ * @param[in] type     The type of the private key. This could be SSH_KEYTYPE_DSS or
+ *                     SSH_KEYTYPE_RSA. Pass 0 to automatically detect the type.
  *
- * @param[in]  passphrase The passphrase to decrypt the private key. Set to null
- *                        if none is needed or it is unknown.
- *
- * @returns               A private_key object containing the private key, or
- *                        NULL on error.
- *
- * @todo Implement to read both DSA and RSA at once.
+ * @param[in] passphrase The passphrase to decrypt the private key. Set to null
+ *                       if none is needed or it is unknown.
  *
+ * @return              A private_key object containing the private key, or
+ *                       NULL on error.
  * @see privatekey_free()
  * @see publickey_from_privatekey()
  */
@@ -679,6 +676,8 @@ ssh_private_key privatekey_from_file(ssh_session session, const char *filename,
   DSA *dsa = NULL;
   RSA *rsa = NULL;
 #endif
+  /* TODO Implement to read both DSA and RSA at once. */
+
   /* needed for openssl initialization */
   ssh_init();
   ssh_log(session, SSH_LOG_RARE, "Trying to open %s", filename);
diff --git a/libssh/server.c b/libssh/server.c
index 7f6ecf0..ea1b926 100644
--- a/libssh/server.c
+++ b/libssh/server.c
@@ -1126,10 +1126,11 @@ char *ssh_message_channel_request_subsystem(ssh_message msg){
 
 /** @brief defines the SSH_MESSAGE callback
  * @param session the current ssh session
- * @param ssh_message_callback_ a function pointer to a callback taking the
+ * @param[in] ssh_message_callback_ a function pointer to a callback taking the
  * current ssh session and received message as parameters. the function returns
  * 0 if the message has been parsed and treated sucessfuly, 1 otherwise (libssh
  * must take care of the response).
+ * @param[in] data void pointer to be passed to callback functions
  */
 void ssh_set_message_callback(ssh_session session,
     int(*ssh_message_callback_)(ssh_session session, ssh_message msg, void *data), void *data){
-- 
cgit