From cf2b12665ed37a04f5bb308a70e8c9b21d3d36d5 Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?Rimas=20Misevi=C4=8Dius?= <rmisev3@gmail.com>
Date: Sun, 22 Oct 2023 16:20:25 +0300
Subject: [PATCH] // update url::get_part_view, is_empty, is_null doxygen
 comments

---
 README.md         |  2 +-
 include/upa/url.h | 22 ++++++++++++++++++++++
 2 files changed, 23 insertions(+), 1 deletion(-)

diff --git a/README.md b/README.md
index 27fb720..3f714bc 100644
--- a/README.md
+++ b/README.md
@@ -12,7 +12,7 @@ This library is up to date with the URL Standard published on
 It implements:
 1. [URL class](https://url.spec.whatwg.org/#url-class): `upa::url`
 2. [URLSearchParams class](https://url.spec.whatwg.org/#interface-urlsearchparams): `upa::url_search_params`
-3. [URL record](https://url.spec.whatwg.org/#concept-url): `upa::url` has functions to examine URL record members
+3. [URL record](https://url.spec.whatwg.org/#concept-url): `upa::url` has functions to examine URL record members: `get_part_view(PartType t)`, `is_empty(PartType t)` and `is_null(PartType t)`
 4. [URL equivalence](https://url.spec.whatwg.org/#url-equivalence): `upa::equals` function
 
 It has some differences from the standard:
diff --git a/include/upa/url.h b/include/upa/url.h
index 52d2a2b..49e3e86 100644
--- a/include/upa/url.h
+++ b/include/upa/url.h
@@ -518,17 +518,39 @@ class url {
     /// @return `true` if URL is valid, `false` otherwise
     bool is_valid() const noexcept;
 
+    /// @brief Gets URL's part (URL record member) as string
+    ///
     /// Function to get ASCII string of any URL's part (URL record member) defined here:
     /// https://url.spec.whatwg.org/#url-representation
     ///
+    /// * `get_part_view(url::SCHEME)` - get a URL’s **scheme** string
+    /// * `get_part_view(url::USERNAME)` - get a URL’s **username** string
+    /// * `get_part_view(url::PASSWORD)` - get a URL’s **password** string
+    /// * `get_part_view(url::HOST)` - get a URL’s **host** serialized to string
+    /// * `get_part_view(url::PORT)` - get a URL’s **port** serialized to string
+    /// * `get_part_view(url::PATH)` - get a URL’s **path** serialized to string
+    /// * `get_part_view(url::QUERY)` - get a URL’s **query** string
+    /// * `get_part_view(url::FRAGMENT)` - get a URL’s **fragment** string
+    ///
     /// @param[in] t URL's part
     /// @return URL's part string; it is empty if part is empty or null
     string_view get_part_view(PartType t) const;
 
+    /// @brief Checks whether the URL's part (URL record member) is empty or null
+    ///
     /// @param[in] t URL's part
     /// @return `true` if URL's part @a t is empty or null, `false` otherwise
     bool is_empty(PartType t) const;
 
+    /// @brief Checks whether the URL's part (URL record member) is null
+    ///
+    /// Only the following [URL record members](https://url.spec.whatwg.org/#concept-url)
+    /// can be null:
+    /// * **host** - check with `is_null(url::HOST)`
+    /// * **port** - check with `is_null(url::PORT)`
+    /// * **query** - check with `is_null(url::QUERY)`
+    /// * **fragment** - check with `is_null(url::FRAGMENT)`
+    ///
     /// @param[in] t URL's part
     /// @return `true` if URL's part @a t is null, `false` otherwise
     bool is_null(PartType t) const noexcept;