aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorEvgeny Grin (Karlson2k) <k2k@narod.ru>2022-09-05 14:54:48 +0300
committerEvgeny Grin (Karlson2k) <k2k@narod.ru>2022-09-05 18:03:09 +0300
commit0531511f18f102455903b2bdcefda73b6df9b966 (patch)
treede44022264c2fecabffb88ef8b1c6f5de8dbc560
parentc3680cb737bcac2a4dc14cca5a80af6ca0de21e7 (diff)
downloadlibmicrohttpd-0531511f18f102455903b2bdcefda73b6df9b966.tar.gz
libmicrohttpd-0531511f18f102455903b2bdcefda73b6df9b966.zip
Editorial doxy improvements
-rw-r--r--src/include/microhttpd.h7
-rw-r--r--src/microhttpd/digestauth.c7
2 files changed, 8 insertions, 6 deletions
diff --git a/src/include/microhttpd.h b/src/include/microhttpd.h
index c545ecc3..bcb7fd13 100644
--- a/src/include/microhttpd.h
+++ b/src/include/microhttpd.h
@@ -4999,7 +4999,7 @@ struct MHD_DigestAuthInfo
4999 * The nc parameter value. 4999 * The nc parameter value.
5000 * Can be used by application to limit the number of nonce re-uses. If @a nc 5000 * Can be used by application to limit the number of nonce re-uses. If @a nc
5001 * is higher than application wants to allow, then auth required response with 5001 * is higher than application wants to allow, then auth required response with
5002 * 'stale=true' could be used to force client to get the fresh 'nonce'. 5002 * 'stale=true' could be used to force client to retry with the fresh 'nonce'.
5003 * If not specified by client or does not have hexadecimal digits only, the 5003 * If not specified by client or does not have hexadecimal digits only, the
5004 * value is #MHD_DIGEST_AUTH_INVALID_NC_VALUE. 5004 * value is #MHD_DIGEST_AUTH_INVALID_NC_VALUE.
5005 */ 5005 */
@@ -5429,10 +5429,11 @@ MHD_queue_auth_required_response3 (struct MHD_Connection *connection,
5429 * 5429 *
5430 * @param connection The MHD connection structure 5430 * @param connection The MHD connection structure
5431 * @return NULL if no username could be found, username provided as 5431 * @return NULL if no username could be found, username provided as
5432 * "userhash" or memory allocation error occurred; 5432 * "userhash", extended notation broken or memory allocation error
5433 * occurs;
5433 * a pointer to the username if found, free using #MHD_free(). 5434 * a pointer to the username if found, free using #MHD_free().
5434 * @warning Returned value must be freed by #MHD_free(). 5435 * @warning Returned value must be freed by #MHD_free().
5435 * @deprecated use MHD_digest_auth_get_username3() 5436 * @sa #MHD_digest_auth_get_username3()
5436 * @ingroup authentication 5437 * @ingroup authentication
5437 */ 5438 */
5438_MHD_EXTERN char * 5439_MHD_EXTERN char *
diff --git a/src/microhttpd/digestauth.c b/src/microhttpd/digestauth.c
index d3f5f595..a6792930 100644
--- a/src/microhttpd/digestauth.c
+++ b/src/microhttpd/digestauth.c
@@ -1087,15 +1087,16 @@ MHD_digest_auth_get_username3 (struct MHD_Connection *connection)
1087/** 1087/**
1088 * Get the username from the authorization header sent by the client 1088 * Get the username from the authorization header sent by the client
1089 * 1089 *
1090 * This function support username in standard and extended notations. 1090 * This function supports username in standard and extended notations.
1091 * "userhash" is not supported by this function. 1091 * "userhash" is not supported by this function.
1092 * 1092 *
1093 * @param connection The MHD connection structure 1093 * @param connection The MHD connection structure
1094 * @return NULL if no username could be found, username provided as 1094 * @return NULL if no username could be found, username provided as
1095 * "userhash" or memory allocation error occurs; 1095 * "userhash", extended notation broken or memory allocation error
1096 * occurs;
1096 * a pointer to the username if found, free using #MHD_free(). 1097 * a pointer to the username if found, free using #MHD_free().
1097 * @warning Returned value must be freed by #MHD_free(). 1098 * @warning Returned value must be freed by #MHD_free().
1098 * @deprecated use MHD_digest_auth_get_username3() 1099 * @sa #MHD_digest_auth_get_username3()
1099 * @ingroup authentication 1100 * @ingroup authentication
1100 */ 1101 */
1101_MHD_EXTERN char * 1102_MHD_EXTERN char *