libmicrohttpd

commit 0531511f18f102455903b2bdcefda73b6df9b966
parent c3680cb737bcac2a4dc14cca5a80af6ca0de21e7
Author: Evgeny Grin (Karlson2k) <k2k@narod.ru>
Date:   Mon,  5 Sep 2022 14:54:48 +0300

Editorial doxy improvements

Diffstat:
M
src/include/microhttpd.h
 | 
7
++++---
M
src/microhttpd/digestauth.c
 | 
7
++++---

2 files changed, 8 insertions(+), 6 deletions(-)
diff --git a/src/include/microhttpd.h b/src/include/microhttpd.h
@@ -4999,7 +4999,7 @@ struct MHD_DigestAuthInfo
    * The nc parameter value.
    * Can be used by application to limit the number of nonce re-uses. If @a nc
    * is higher than application wants to allow, then auth required response with
-   * 'stale=true' could be used to force client to get the fresh 'nonce'.
+   * 'stale=true' could be used to force client to retry with the fresh 'nonce'.
    * If not specified by client or does not have hexadecimal digits only, the
    * value is #MHD_DIGEST_AUTH_INVALID_NC_VALUE.
    */
@@ -5429,10 +5429,11 @@ MHD_queue_auth_required_response3 (struct MHD_Connection *connection,
  *
  * @param connection The MHD connection structure
  * @return NULL if no username could be found, username provided as
- *         "userhash" or memory allocation error occurred;
+ *         "userhash", extended notation broken or memory allocation error
+ *         occurs;
  *         a pointer to the username if found, free using #MHD_free().
  * @warning Returned value must be freed by #MHD_free().
- * @deprecated use MHD_digest_auth_get_username3()
+ * @sa #MHD_digest_auth_get_username3()
  * @ingroup authentication
  */
 _MHD_EXTERN char *
diff --git a/src/microhttpd/digestauth.c b/src/microhttpd/digestauth.c
@@ -1087,15 +1087,16 @@ MHD_digest_auth_get_username3 (struct MHD_Connection *connection)
 /**
  * Get the username from the authorization header sent by the client
  *
- * This function support username in standard and extended notations.
+ * This function supports username in standard and extended notations.
  * "userhash" is not supported by this function.
  *
  * @param connection The MHD connection structure
  * @return NULL if no username could be found, username provided as
- *         "userhash" or memory allocation error occurs;
+ *         "userhash", extended notation broken or memory allocation error
+ *         occurs;
  *         a pointer to the username if found, free using #MHD_free().
  * @warning Returned value must be freed by #MHD_free().
- * @deprecated use MHD_digest_auth_get_username3()
+ * @sa #MHD_digest_auth_get_username3()
  * @ingroup authentication
  */
 _MHD_EXTERN char *