Skip to content

Commit d192e17

Browse files
committed
docs: add comments for the url_host_type enum
1 parent c998e47 commit d192e17

File tree

1 file changed

+10
-0
lines changed

1 file changed

+10
-0
lines changed

include/ada/url_base.h

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -17,8 +17,18 @@ namespace ada {
1717
* Type of URL host as an enum.
1818
*/
1919
enum url_host_type : uint8_t {
20+
/**
21+
* Represents common URLs such as "https://www.google.com"
22+
*/
2023
DEFAULT = 0,
24+
/**
25+
* Represents ipv4 addresses such as "http://127.0.0.1"
26+
*/
2127
IPV4 = 1,
28+
/**
29+
* Represents ipv6 addresses such as
30+
* "http://[2001:db8:3333:4444:5555:6666:7777:8888]"
31+
*/
2232
IPV6 = 2,
2333
};
2434

0 commit comments

Comments
 (0)