aboutsummaryrefslogtreecommitdiff
path: root/libssh
diff options
context:
space:
mode:
authorAndreas Schneider <mail@cynapses.org>2010-04-04 15:44:01 +0200
committerAndreas Schneider <mail@cynapses.org>2010-04-04 15:51:54 +0200
commita75a2bf533324f64557f54e97b0012951ea38e61 (patch)
treecf7aef716ec9b1b36f03e735b88b0db79b1fe396 /libssh
parent8dcfc3c94ab9e566f658d7dfc52b2752e3c47848 (diff)
downloadlibssh-a75a2bf533324f64557f54e97b0012951ea38e61.tar.gz
libssh-a75a2bf533324f64557f54e97b0012951ea38e61.tar.xz
libssh-a75a2bf533324f64557f54e97b0012951ea38e61.zip
Fixed documentation of dh functions.
Diffstat (limited to 'libssh')
-rw-r--r--libssh/dh.c20
1 files changed, 13 insertions, 7 deletions
diff --git a/libssh/dh.c b/libssh/dh.c
index f33d9997..34263c26 100644
--- a/libssh/dh.c
+++ b/libssh/dh.c
@@ -804,14 +804,18 @@ error:
return rc;
}
-/** \addtogroup ssh_session
- * @{ */
+/**
+ * @addtogroup libssh_session
+ *
+ * @{
+ */
+
/**
* @brief Allocates a buffer with the MD5 hash of the server public key.
*
- * @param session The SSH session to use.
+ * @param[in] session The SSH session to use.
*
- * @param hash The buffer to allocate.
+ * @param[in] hash The buffer to allocate.
*
* @return The bytes allocated or < 0 on error.
*
@@ -857,10 +861,11 @@ int ssh_get_pubkey_hash(ssh_session session, unsigned char **hash) {
/**
* @brief Deallocate the hash obtained by ssh_get_pubkey_hash.
+ *
* This is required under Microsoft platform as this library might use a
* different C library than your software, hence a different heap.
*
- * @param hash The buffer to deallocate.
+ * @param[in] hash The buffer to deallocate.
*
* @see ssh_get_pubkey_hash()
*/
@@ -1037,5 +1042,6 @@ int signature_verify(ssh_session session, ssh_string signature) {
return err;
}
-/** @} */
-/* vim: set ts=2 sw=2 et cindent: */
+/* @} */
+
+/* vim: set ts=4 sw=4 et cindent: */