From 846196300f82fd1b5f5bac4b6a4ebd9540a4706d Mon Sep 17 00:00:00 2001
From: "Evgeny Grin (Karlson2k)" <k2k@narod.ru>
Date: Fri, 10 Jun 2022 11:17:12 +0300
Subject: MHD_free(): updated doxy

---
 src/include/microhttpd.h | 28 ++++++++++++++++------------
 1 file changed, 16 insertions(+), 12 deletions(-)

(limited to 'src/include/microhttpd.h')

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
@@ -2925,6 +2925,22 @@ MHD_get_timeout (struct MHD_Daemon *daemon,
                  MHD_UNSIGNED_LONG_LONG *timeout);
 
 
+/**
+ * Free the memory allocated by MHD.
+ *
+ * If any MHD function explicitly mentions that returned pointer must be
+ * freed by this function, then no other method must be used to free
+ * the memory.
+ *
+ * @param ptr the pointer to free.
+ * @sa #MHD_digest_auth_get_username(), #MHD_basic_auth_get_username_password3()
+ * @sa #MHD_basic_auth_get_username_password()
+ * @note Available since #MHD_VERSION 0x00095600
+ * @ingroup specialized
+ */
+_MHD_EXTERN void
+MHD_free (void *ptr);
+
 /**
  * Obtain timeout value for external polling function for this daemon.
  *
@@ -4329,18 +4345,6 @@ _MHD_EXTERN char *
 MHD_digest_auth_get_username (struct MHD_Connection *connection);
 
 
-/**
- * Free the memory given by @a ptr. Calls "free(ptr)".  This function
- * should be used to free the username returned by
- * #MHD_digest_auth_get_username().
- * @note Available since #MHD_VERSION 0x00095600
- *
- * @param ptr pointer to free.
- */
-_MHD_EXTERN void
-MHD_free (void *ptr);
-
-
 /**
  * Which digest algorithm should MHD use for HTTP digest authentication?
  */
-- 
cgit v1.2.3