[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]
[libmicrohttpd] 02/09: Editorial doxy improvements
From: |
gnunet |
Subject: |
[libmicrohttpd] 02/09: Editorial doxy improvements |
Date: |
Sun, 11 Sep 2022 19:56:04 +0200 |
This is an automated email from the git hooks/post-receive script.
karlson2k pushed a commit to branch master
in repository libmicrohttpd.
commit 0531511f18f102455903b2bdcefda73b6df9b966
Author: Evgeny Grin (Karlson2k) <k2k@narod.ru>
AuthorDate: Mon Sep 5 14:54:48 2022 +0300
Editorial doxy improvements
---
src/include/microhttpd.h | 7 ++++---
src/microhttpd/digestauth.c | 7 ++++---
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
* 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
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)
/**
* 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 *
--
To stop receiving notification emails like this one, please contact
gnunet@gnunet.org.
- [libmicrohttpd] branch master updated (2699d278 -> 8318f56e), gnunet, 2022/09/11
- [libmicrohttpd] 02/09: Editorial doxy improvements,
gnunet <=
- [libmicrohttpd] 05/09: mhd_bithelpers: added more 64 bit manipulation functions/macros, gnunet, 2022/09/11
- [libmicrohttpd] 06/09: microhttpd.h: fixed typo in doxy, gnunet, 2022/09/11
- [libmicrohttpd] 01/09: Digest Auth API: do not store 'userhash' in 'username' members, gnunet, 2022/09/11
- [libmicrohttpd] 07/09: Implemented SHA-512/256 hashing support, gnunet, 2022/09/11
- [libmicrohttpd] 09/09: digestauth: added support for SHA-512/256, made MD5 and SHA-256 optional, gnunet, 2022/09/11
- [libmicrohttpd] 04/09: mhd_bithelpers: Fixed typo in comment, gnunet, 2022/09/11
- [libmicrohttpd] 08/09: test_dauth_user{digest, hash}: fixed copy-paste errors, gnunet, 2022/09/11
- [libmicrohttpd] 03/09: configure: fixed underquoting, typos, wording, gnunet, 2022/09/11