[libmicrohttpd] 02/02: digestauth: minor doxy correction for public API

[gnunet]

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

karlson2k pushed a commit to branch master
in repository libmicrohttpd.

commit 83f50ffcea81a01ee4b06391a884df277d31c76d
Author: Evgeny Grin (Karlson2k) <k2k@narod.ru>
AuthorDate: Tue Aug 16 10:20:11 2022 +0300

    digestauth: minor doxy correction for public API
---
 src/include/microhttpd.h    |  9 +++++----
 src/microhttpd/digestauth.c | 13 +++++++------
 2 files changed, 12 insertions(+), 10 deletions(-)

diff --git a/src/include/microhttpd.h b/src/include/microhttpd.h
index d3765b6c..b2356e5a 100644
--- a/src/include/microhttpd.h
+++ b/src/include/microhttpd.h
@@ -5088,7 +5088,7 @@ enum MHD_DigestAuthResult
  *               returned;
  *               zero for no limit
  * @param mqop the QOP to use
- * @param malgo3 digest algorithms allowed to use, fail if algorithm specified
+ * @param malgo3 digest algorithms allowed to use, fail if algorithm used
  *               by the client is not allowed by this parameter
  * @return #MHD_DAUTH_OK if authenticated,
  *         the error code otherwise
@@ -5133,7 +5133,7 @@ MHD_digest_auth_check3 (struct MHD_Connection *connection,
  *               returned;
  *               zero for no limit
  * @param mqop the QOP to use
- * @param malgo3 digest algorithms allowed to use, fail if algorithm specified
+ * @param malgo3 digest algorithms allowed to use, fail if algorithm used
  *               by the client is not allowed by this parameter;
  *               both MD5-based and SHA-256-based algorithms cannot be used at
  *               the same time for this function as @a userdigest_size must
@@ -5193,8 +5193,9 @@ MHD_digest_auth_check_digest3 (struct MHD_Connection 
*connection,
  *                     to retry immediately with the new nonce and the same
  *                     credentials, without asking user for the new password
  * @param mqop the QOP to use
- * @param malgo3 digest algorithm to use, if several algorithms are specified
- *               then MD5 is used (if allowed)
+ * @param malgo3 digest algorithm to use, MHD selects; if several algorithms
+ *               are allowed then MD5 is preferred (currently, may be changed
+ *               in next versions)
  * @param userhash_support if set to non-zero value (#MHD_YES) then support of
  *                         userhash is indicated, the client may provide
  *                         hash("username:realm") instead of username in
diff --git a/src/microhttpd/digestauth.c b/src/microhttpd/digestauth.c
index 1061512d..0f428d86 100644
--- a/src/microhttpd/digestauth.c
+++ b/src/microhttpd/digestauth.c
@@ -2660,7 +2660,7 @@ MHD_digest_auth_check (struct MHD_Connection *connection,
  *               returned;
  *               zero for no limit
  * @param mqop the QOP to use
- * @param malgo3 digest algorithms allowed to use, fail if algorithm specified
+ * @param malgo3 digest algorithms allowed to use, fail if algorithm used
  *               by the client is not allowed by this parameter
  * @return #MHD_DAUTH_OK if authenticated,
  *         the error code otherwise
@@ -2718,7 +2718,7 @@ MHD_digest_auth_check3 (struct MHD_Connection *connection,
  *               returned;
  *               zero for no limit
  * @param mqop the QOP to use
- * @param malgo3 digest algorithms allowed to use, fail if algorithm specified
+ * @param malgo3 digest algorithms allowed to use, fail if algorithm used
  *               by the client is not allowed by this parameter;
  *               both MD5-based and SHA-256-based algorithms cannot be used at
  *               the same time for this function as @a userdigest_size must
@@ -2934,8 +2934,8 @@ MHD_digest_auth_check_digest (struct MHD_Connection 
*connection,
  *               same authorisation could be used, URIs can be in form
  *               "path-absolute" (the path for the same host with initial 
slash)
  *               or in form "absolute-URI" (the full path with protocol), in
- *               any case client may assume that any URI which starts with
- *               any of specified URI is in the same "protection space";
+ *               any case client may assume that URI is in the same "protection
+ *               space" if it starts with any of values specified here;
  *               could be NULL (clients typically assume that the same
  *               credentials could be used for any URI on the same host)
  * @param response the reply to send; should contain the "access denied"
@@ -2947,8 +2947,9 @@ MHD_digest_auth_check_digest (struct MHD_Connection 
*connection,
  *                     to retry immediately with the new nonce and the same
  *                     credentials, without asking user for the new password
  * @param mqop the QOP to use
- * @param malgo3 digest algorithm to use, if several algorithms are specified
- *               then MD5 is used (if allowed)
+ * @param malgo3 digest algorithm to use, MHD selects; if several algorithms
+ *               are allowed then MD5 is preferred (currently, may be changed
+ *               in next versions)
  * @param userhash_support if set to non-zero value (#MHD_YES) then support of
  *                         userhash is indicated, the client may provide
  *                         hash("username:realm") instead of username in

-- 
To stop receiving notification emails like this one, please contact
gnunet@gnunet.org.