Changeset 102554 in vbox for trunk

Timestamp:

Dec 8, 2023 5:01:40 PM (14 months ago)

Author:

vboxsync

Message:

IPRT/uri.h: Improved docs.

File:

• trunk/include/iprt/uri.h (modified) (9 diffs)

trunk/include/iprt/uri.h

@@ -144 +144 @@
  * Extract the scheme out of a parsed URI.
  *
- * @returns the scheme if the URI is valid, NULL otherwise.
+ * @returns The allocated scheme if the URI is valid, NULL otherwise.  Must be free'd via RTStrFree().
  * @param   pszUri              The URI passed to RTUriParse when producing the
  *                              info in @a pParsed.
@@ -154 +154 @@
  * Extract the authority out of a parsed URI.
  *
- * @returns the authority if the URI contains one, NULL otherwise.
+ * @returns The allocated authority if the URI contains one, NULL otherwise.  Must be free'd via RTStrFree().
  * @param   pszUri              The URI passed to RTUriParse when producing the
  *                              info in @a pParsed.
@@ -165 +165 @@
  * Extract the username out of the authority component in a parsed URI.
  *
- * @returns The username if the URI contains one, otherwise NULL.
+ * @returns The allocated username if the URI contains one, otherwise NULL.  Must be free'd via RTStrFree().
  * @param   pszUri              The URI passed to RTUriParse when producing the
  *                              info in @a pParsed.
@@ -178 +178 @@
  * Extract the password out of the authority component in a parsed URI.
  *
- * @returns The password if the URI contains one, otherwise NULL.
+ * @returns The allocated password if the URI contains one, otherwise NULL.  Must be free'd via RTStrFree().
  * @param   pszUri              The URI passed to RTUriParse when producing the
  *                              info in @a pParsed.
@@ -191 +191 @@
  * Extract the host out of the authority component in a parsed URI.
  *
- * @returns The host if the URI contains one, otherwise NULL.
+ * @returns The allocated host if the URI contains one, otherwise NULL.  Must be free'd via RTStrFree().
  * @param   pszUri              The URI passed to RTUriParse when producing the
  *                              info in @a pParsed.
@@ -214 +214 @@
  * Extract the path out of a parsed URI.
  *
- * @returns the path if the URI contains one, NULL otherwise.
+ * @returns The allocated path if the URI contains one, NULL otherwise.  Must be free'd via RTStrFree().
  * @param   pszUri              The URI passed to RTUriParse when producing the
  *                              info in @a pParsed.
@@ -224 +224 @@
  * Extract the query out of a parsed URI.
  *
- * @returns the query if the URI contains one, NULL otherwise.
+ * @returns The allocated query if the URI contains one, NULL otherwise.  Must be free'd via RTStrFree().
  * @param   pszUri              The URI passed to RTUriParse when producing the
  *                              info in @a pParsed.
@@ -234 +234 @@
  * Extract the fragment out of a parsed URI.
  *
- * @returns the fragment if the URI contains one, NULL otherwise.
+ * @returns The allocated fragment if the URI contains one, NULL otherwise.   Must be free'd via RTStrFree().
  * @param   pszUri              The URI passed to RTUriParse when producing the
  *                              info in @a pParsed.
@@ -246 +246 @@
  * Creates a generic URI.
  *
- * The returned pointer must be freed using RTStrFree().
- *
- * @returns the new URI on success, NULL otherwise.
+ * @returns The allocated URI on success, NULL otherwise.  Must be free'd via RTStrFree().
  * @param   pszScheme           The URI scheme.
  * @param   pszAuthority        The authority part of the URI (optional).