Changeset 102562 in vbox for trunk/include

Timestamp:

Dec 11, 2023 8:32:42 AM (16 months ago)

Author:

vboxsync

svn:sync-xref-src-repo-rev:

160708

Message:

IPRT/http: Fixed a memory leak, updated docs. bugref:9437

File:

• trunk/include/iprt/http-common.h (modified) (1 diff)

trunk/include/iprt/http-common.h

@@ -196 +196 @@
 
 /**
- * Returns the name of the HTTP method.
+ * Returns the name of the HTTP method as a string.
+ *
  * @returns Read only string.
- * @param   enmMethod       The HTTP method to name.
+ * @param   enmMethod       The HTTP method to return string for.
  */
 RTR3DECL(const char *) RTHttpMethodToStr(RTHTTPMETHOD enmMethod);
 
+/**
+ * Returns the name of the HTTP status as a string.
+ *
+ * @returns Read only string.
+ * @param   enmSts          The HTTP status to return string for.
+ */
 RTR3DECL(const char *) RTHttpStatusToStr(RTHTTPSTATUS enmSts);
 
+/**
+ * Initializes an HTTP header list.
+ *
+ * @returns VBox status code.
+ * @param   hHdrList            Header list to initialize.
+ */
 RTR3DECL(int) RTHttpHeaderListInit(PRTHTTPHEADERLIST hHdrList);
 
+/**
+ * Destroys an HTTP header list.
+ *
+ * @param   hHdrList            Header list to destroy.
+ *                              The object will be invalid on return.
+ */
 RTR3DECL(void) RTHttpHeaderListDestroy(RTHTTPHEADERLIST hHdrList);