diff options
author | Evgeny Grin (Karlson2k) <k2k@narod.ru> | 2022-06-10 11:17:12 +0300 |
---|---|---|
committer | Evgeny Grin (Karlson2k) <k2k@narod.ru> | 2022-06-10 11:17:12 +0300 |
commit | 846196300f82fd1b5f5bac4b6a4ebd9540a4706d (patch) | |
tree | 92edef487ab3690245beeb163c9cf5150ffcc918 /src/include/microhttpd.h | |
parent | e1f5396ad46bb8629107853ffc1a95246c3a0efc (diff) | |
download | libmicrohttpd-846196300f82fd1b5f5bac4b6a4ebd9540a4706d.tar.gz libmicrohttpd-846196300f82fd1b5f5bac4b6a4ebd9540a4706d.zip |
MHD_free(): updated doxy
Diffstat (limited to 'src/include/microhttpd.h')
-rw-r--r-- | src/include/microhttpd.h | 28 |
1 files changed, 16 insertions, 12 deletions
diff --git a/src/include/microhttpd.h b/src/include/microhttpd.h index 4936e912..5ddd60da 100644 --- a/src/include/microhttpd.h +++ b/src/include/microhttpd.h | |||
@@ -2926,6 +2926,22 @@ MHD_get_timeout (struct MHD_Daemon *daemon, | |||
2926 | 2926 | ||
2927 | 2927 | ||
2928 | /** | 2928 | /** |
2929 | * Free the memory allocated by MHD. | ||
2930 | * | ||
2931 | * If any MHD function explicitly mentions that returned pointer must be | ||
2932 | * freed by this function, then no other method must be used to free | ||
2933 | * the memory. | ||
2934 | * | ||
2935 | * @param ptr the pointer to free. | ||
2936 | * @sa #MHD_digest_auth_get_username(), #MHD_basic_auth_get_username_password3() | ||
2937 | * @sa #MHD_basic_auth_get_username_password() | ||
2938 | * @note Available since #MHD_VERSION 0x00095600 | ||
2939 | * @ingroup specialized | ||
2940 | */ | ||
2941 | _MHD_EXTERN void | ||
2942 | MHD_free (void *ptr); | ||
2943 | |||
2944 | /** | ||
2929 | * Obtain timeout value for external polling function for this daemon. | 2945 | * Obtain timeout value for external polling function for this daemon. |
2930 | * | 2946 | * |
2931 | * This function set value to the amount of milliseconds for which polling | 2947 | * This function set value to the amount of milliseconds for which polling |
@@ -4330,18 +4346,6 @@ MHD_digest_auth_get_username (struct MHD_Connection *connection); | |||
4330 | 4346 | ||
4331 | 4347 | ||
4332 | /** | 4348 | /** |
4333 | * Free the memory given by @a ptr. Calls "free(ptr)". This function | ||
4334 | * should be used to free the username returned by | ||
4335 | * #MHD_digest_auth_get_username(). | ||
4336 | * @note Available since #MHD_VERSION 0x00095600 | ||
4337 | * | ||
4338 | * @param ptr pointer to free. | ||
4339 | */ | ||
4340 | _MHD_EXTERN void | ||
4341 | MHD_free (void *ptr); | ||
4342 | |||
4343 | |||
4344 | /** | ||
4345 | * Which digest algorithm should MHD use for HTTP digest authentication? | 4349 | * Which digest algorithm should MHD use for HTTP digest authentication? |
4346 | */ | 4350 | */ |
4347 | enum MHD_DigestAuthAlgorithm | 4351 | enum MHD_DigestAuthAlgorithm |