MHD_free(): updated doxy

2 files changed, 26 insertions, 17 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,
 
 
 /**
+ * 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.
  *
  * 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);
 
 
 /**
- * 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?
  */
 enum MHD_DigestAuthAlgorithm
diff --git a/src/microhttpd/daemon.c b/src/microhttpd/daemon.c
index 013c84c5..1e591ce3 100644
--- a/src/microhttpd/daemon.c
+++ b/src/microhttpd/daemon.c
@@ -204,12 +204,17 @@ MHD_default_logger_ (void *cls,
 
 
 /**
- * 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
+ * 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 pointer to free.
+ * @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)