aboutsummaryrefslogtreecommitdiff
path: root/libssh/keyfiles.c
diff options
context:
space:
mode:
authorAris Adamantiadis <aris@0xbadc0de.be>2010-08-28 21:05:24 +0200
committerAris Adamantiadis <aris@0xbadc0de.be>2010-08-28 21:05:24 +0200
commit29a229724bebaf1947a80a3dca252206232a0643 (patch)
tree40483f41509f34b2e487b793f63d7e2a81ed70ff /libssh/keyfiles.c
parenta9fafc32a877e42d4044a637bed87845faabe189 (diff)
downloadlibssh-29a229724bebaf1947a80a3dca252206232a0643.tar.gz
libssh-29a229724bebaf1947a80a3dca252206232a0643.tar.xz
libssh-29a229724bebaf1947a80a3dca252206232a0643.zip
Fix a few documentation issues
Diffstat (limited to 'libssh/keyfiles.c')
-rw-r--r--libssh/keyfiles.c21
1 files changed, 10 insertions, 11 deletions
diff --git a/libssh/keyfiles.c b/libssh/keyfiles.c
index f715d25a..f50afa76 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);