[GNUnet-SVN] [libmicrohttpd] 01/10: Fixed doxygen comments, Fixed spelling in comments

[gnunet]

This is an automated email from the git hooks/post-receive script.

karlson2k pushed a commit to branch master
in repository libmicrohttpd.

commit edfdbbf794837190729f1bc9c87e6cfbe26717d9
Author: Evgeny Grin (Karlson2k) <address@hidden>
AuthorDate: Tue May 21 20:44:03 2019 +0300

    Fixed doxygen comments,
    Fixed spelling in comments
---
 src/include/microhttpd.h    |  9 ++++-----
 src/include/microhttpd2.h   |  4 ++--
 src/lib/daemon_start.c      |  8 ++++----
 src/microhttpd/connection.c |  1 -
 src/microhttpd/daemon.c     |  4 ++--
 src/microhttpd/digestauth.c | 10 +++++-----
 src/microhttpd/sha256.c     |  2 +-
 src/microhttpd/sha256.h     |  2 +-
 8 files changed, 19 insertions(+), 21 deletions(-)

diff --git a/src/include/microhttpd.h b/src/include/microhttpd.h
index a492071a..117062e8 100644
--- a/src/include/microhttpd.h
+++ b/src/include/microhttpd.h
@@ -1187,9 +1187,9 @@ typedef void
  * @param cls closure
  * @param connection the HTTPS connection
  * @param username the user name claimed by the other side
- * @param psk[out] to be set to the pre-shared-key; should be allocated with 
malloc(),
+ * @param[out] psk to be set to the pre-shared-key; should be allocated with 
malloc(),
  *                 will be freed by MHD
- * @param psk_size[out] to be set to the number of bytes in @a psk
+ * @param[out] psk_size to be set to the number of bytes in @a psk
  * @return 0 on success, -1 on errors
  */
 typedef int
@@ -2654,7 +2654,6 @@ MHD_lookup_connection_value (struct MHD_Connection 
*connection,
  * @param[out] value_size_ptr the pointer variable, which will set to found 
value,
  *                            will not be updated if key not found,
  *                            could be NULL
- * @param key_size the length of @a key in bytes
  * @return #MHD_YES if key is found,
  *         #MHD_NO otherwise.
  * @ingroup request
@@ -2664,8 +2663,8 @@ MHD_lookup_connection_value_n (struct MHD_Connection 
*connection,
                                enum MHD_ValueKind kind,
                                const char *key,
                                size_t key_size,
-                               const char **value,
-                               size_t *value_size);
+                               const char **value_ptr,
+                               size_t *value_size_ptr);
 
 
 /**
diff --git a/src/include/microhttpd2.h b/src/include/microhttpd2.h
index 54120570..710115d1 100644
--- a/src/include/microhttpd2.h
+++ b/src/include/microhttpd2.h
@@ -2187,9 +2187,9 @@ MHD_daemon_tls_mem_dhparams (struct MHD_Daemon *daemon,
  * @param cls closure
  * @param connection the HTTPS connection
  * @param username the user name claimed by the other side
- * @param psk[out] to be set to the pre-shared-key; should be allocated with 
malloc(),
+ * @param[out] psk to be set to the pre-shared-key; should be allocated with 
malloc(),
  *                 will be freed by MHD
- * @param psk_size[out] to be set to the number of bytes in @a psk
+ * @param[out] psk_size to be set to the number of bytes in @a psk
  * @return 0 on success, -1 on errors 
  */
 typedef int
diff --git a/src/lib/daemon_start.c b/src/lib/daemon_start.c
index 2d44fe51..8e2c9fb5 100644
--- a/src/lib/daemon_start.c
+++ b/src/lib/daemon_start.c
@@ -35,7 +35,7 @@
  * Set listen socket options to allow port rebinding (or not)
  * depending on how MHD was configured.
  *
- * @param daemon[in,out] the daemon with the listen socket to configure
+ * @param[in,out] daemon the daemon with the listen socket to configure
  * @return #MHD_SC_OK on success (or non-fatal errors)
  */
 static enum MHD_StatusCode
@@ -148,7 +148,7 @@ configure_listen_reuse (struct MHD_Daemon *daemon)
 /**
  * Open, configure and bind the listen socket (if required).
  *
- * @param daemon[in,out] daemon to open the socket for
+ * @param[in,out] daemon daemon to open the socket for
  * @return #MHD_SC_OK on success
  */
 static enum MHD_StatusCode
@@ -413,7 +413,7 @@ open_listen_socket (struct MHD_Daemon *daemon)
  * a listen socket or if the port was 0 and the OS picked
  * a free one).
  *
- * @param daemon[in,out] daemon to obtain the port number for
+ * @param[in,out] daemon daemon to obtain the port number for
  */
 static void
 get_listen_port_number (struct MHD_Daemon *daemon)
@@ -659,7 +659,7 @@ MHD_polling_thread (void *cls)
 /**
  * Setup the thread pool (if needed).
  *
- * @param daemon[in,out] daemon to setup thread pool for
+ * @param[in,out] daemon daemon to setup thread pool for
  * @return #MHD_SC_OK on success
  */
 static enum MHD_StatusCode
diff --git a/src/microhttpd/connection.c b/src/microhttpd/connection.c
index b73e6d5a..308fb33a 100644
--- a/src/microhttpd/connection.c
+++ b/src/microhttpd/connection.c
@@ -949,7 +949,6 @@ MHD_lookup_connection_value (struct MHD_Connection 
*connection,
  * @param[out] value_size_ptr the pointer variable, which will set to found 
value,
  *                            will not be updated if key not found,
  *                            could be NULL
- * @param key_size the length of @a key in bytes
  * @return #MHD_YES if key is found,
  *         #MHD_NO otherwise.
  * @ingroup request
diff --git a/src/microhttpd/daemon.c b/src/microhttpd/daemon.c
index af137a80..fef1f8b3 100644
--- a/src/microhttpd/daemon.c
+++ b/src/microhttpd/daemon.c
@@ -1197,7 +1197,7 @@ call_handlers (struct MHD_Connection *con,
    * connections are processed individually. */
   /* Note: no need to check for read buffer availability for
    * TLS read-ready connection in 'read info' state as connection
-   * without space in read buffer will be market as 'info block'. */
+   * without space in read buffer will be marked as 'info block'. */
   if ( (! con->daemon->data_already_pending) &&
        (0 == (con->daemon->options & MHD_USE_THREAD_PER_CONNECTION)) )
     {
@@ -2177,7 +2177,7 @@ MHD_tls_push_func_(gnutls_transport_ptr_t trnsp,
  *
  * @param session the session to lookup PSK for
  * @param username username to lookup PSK for
- * @param key[out] where to write PSK
+ * @param[out] key where to write PSK
  * @return 0 on success, -1 on error
  */
 static int
diff --git a/src/microhttpd/digestauth.c b/src/microhttpd/digestauth.c
index ae5034b8..06c1a5a9 100644
--- a/src/microhttpd/digestauth.c
+++ b/src/microhttpd/digestauth.c
@@ -156,7 +156,7 @@ struct DigestAlgorithm
    * Compute final @a digest.
    *
    * @param ctx context to use
-   * @param digest[out] where to write the result,
+   * @param[out] digest where to write the result,
    *        must be @e digest_length bytes long
    */
   void
@@ -198,7 +198,7 @@ cvthex (const unsigned char *bin,
  * @param alg The hash algorithm used, can be "md5" or "md5-sess"
  *            or "sha-256" or "sha-256-sess"
  *    Note that the rest of the code does not support the the "-sess" variants!
- * @param da[in,out] digest implementation, must match @a alg; the
+ * @param[in,out] da digest implementation, must match @a alg; the
  *          da->sessionkey will be initialized to the digest in HEX
  * @param digest An `unsigned char *' pointer to the binary MD5 sum
  *                     for the precalculated hash value 
"username:realm:password"
@@ -263,7 +263,7 @@ digest_calc_ha1_from_digest (const char *alg,
  * @param password A `char *' pointer to the password value
  * @param nonce A `char *' pointer to the nonce value
  * @param cnonce A `char *' pointer to the cnonce value
- * @param da[in,out] digest algorithm to use, and where to write
+ * @param[in,out] da digest algorithm to use, and where to write
  *         the sessionkey to
  */
 static void
@@ -317,7 +317,7 @@ digest_calc_ha1_from_user (const char *alg,
  * @param method method from request
  * @param uri requested URL
  * @param hentity H(entity body) if qop="auth-int"
- * @param da[in,out] digest algorithm to use, also
+ * @param[in,out] da digest algorithm to use, also
  *        we write da->sessionkey (set to response request-digest or 
response-digest)
  */
 static void
@@ -835,7 +835,7 @@ check_argument_match (struct MHD_Connection *connection,
  * Authenticates the authorization header sent by the client
  *
  * @param connection The MHD connection structure
- * @param da[in,out] digest algorithm to use for checking (written to as
+ * @param[in,out] da digest algorithm to use for checking (written to as
  *         part of the calculations, but the values left in the struct
  *         are not actually expected to be useful for the caller)
  * @param realm The realm presented to the client
diff --git a/src/microhttpd/sha256.c b/src/microhttpd/sha256.c
index 801f920b..6336c986 100644
--- a/src/microhttpd/sha256.c
+++ b/src/microhttpd/sha256.c
@@ -300,7 +300,7 @@ sha256_update (void *ctx_,
  * Finalise SHA256 calculation, return digest.
  *
  * @param ctx_ must be a `struct sha256_ctx *`
- * @param digest[out] set to the hash, must be #SHA256_DIGEST_SIZE bytes
+ * @param[out] digest set to the hash, must be #SHA256_DIGEST_SIZE bytes
  */
 void
 sha256_finish (void *ctx_,
diff --git a/src/microhttpd/sha256.h b/src/microhttpd/sha256.h
index 7926e7ea..03700080 100644
--- a/src/microhttpd/sha256.h
+++ b/src/microhttpd/sha256.h
@@ -84,7 +84,7 @@ sha256_update (void *ctx_,
  * Finalise SHA256 calculation, return digest.
  *
  * @param ctx_ must be a `struct sha256_ctx *`
- * @param digest[out] set to the hash, must be #SHA256_DIGEST_SIZE bytes
+ * @param[out] digest set to the hash, must be #SHA256_DIGEST_SIZE bytes
  */
 void
 sha256_finish (void *ctx_,

-- 
To stop receiving notification emails like this one, please contact
address@hidden