Переглянути джерело

Improved doxy for MHD_free() and MHD_digest_auth_get_username()

Evgeny Grin (Karlson2k) 8 роки тому
батько
коміт
54cd6ac437

+ 1 - 0
src/include/microhttpd.h

@@ -3117,6 +3117,7 @@ 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 Since v0.9.56
  *
  * @param ptr pointer to free.
  */

+ 1 - 0
src/microhttpd/digestauth.c

@@ -462,6 +462,7 @@ check_nonce_nc (struct MHD_Connection *connection,
  * @param connection The MHD connection structure
  * @return NULL if no username could be found, a pointer
  * 			to the username if found
+ * @warning Returned value must be freed by #MHD_free().
  * @ingroup authentication
  */
 char *

+ 2 - 1
src/microhttpd/memorypool.c

@@ -81,10 +81,11 @@ struct MemoryPool
  * 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 Since v0.9.56
  *
  * @param ptr pointer to free.
  */
-void
+_MHD_EXTERN void
 MHD_free (void *ptr)
 {
   free (ptr);