diff options
author | Grant Erickson <gerickson@nuovations.com> | 2023-12-06 11:05:22 -0800 |
---|---|---|
committer | Marcel Holtmann <marcel@holtmann.org> | 2023-12-08 01:55:44 +0100 |
commit | 2c9865bb5a315f6293fa12218b8fde5c800c0456 (patch) | |
tree | 7a258b72cb22af6cf3e41b753ecbb1f67d13883b | |
parent | f1f292b19dc9760a7872efa4813b31732159c616 (diff) | |
download | connman-2c9865bb5a315f6293fa12218b8fde5c800c0456.tar.gz |
connection: Document 'is_addr_any_str'.
This adds documentation to the 'is_addr_any_str' function.
-rw-r--r-- | src/connection.c | 21 |
1 files changed, 21 insertions, 0 deletions
diff --git a/src/connection.c b/src/connection.c index f1e91c7c8..053164c36 100644 --- a/src/connection.c +++ b/src/connection.c @@ -792,6 +792,27 @@ static bool is_ipv6_addr_any_str(const char *address) return g_strcmp0(ipv6_addr_any_str, address) == 0; } +/** + * @brief + * Determine whether the specified text-formatted IP address is + * the "any" or "unspecified" address. + * + * This determines whether the specified text-formatted IP address + * is the "any" or "unspecified" address. + * + * @param[in] address A pointer to an immutable null-terminated C + * string containing the text-formatted address + * to determine whether it is the IP "any" or + * "unspecified address. + * + * @returns + * True if @a address is the "any" or "unspecified" IP address; + * otherwise, false. + * + * @sa is_ipv4_addr_any_str + * @sa is_ipv6_addr_any_str + * + */ static bool is_addr_any_str(const char *address) { if (!address) |