aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorRichard Walters <rwalters@digitalstirling.com>2018-07-01 15:24:27 -0700
committerRichard Walters <rwalters@digitalstirling.com>2018-07-01 15:24:27 -0700
commit8b48f3a3cce33a7e111cffca16e72b58119229e7 (patch)
tree74ff663c9737838807d85e24927f7601d5e9afce
parentd3a446cd9c3846735f4ea9e5270352633c597071 (diff)
Added missing documentation
-rw-r--r--src/Uri.cpp14
1 files changed, 14 insertions, 0 deletions
diff --git a/src/Uri.cpp b/src/Uri.cpp
index 44ce0b0..1d27a7a 100644
--- a/src/Uri.cpp
+++ b/src/Uri.cpp
@@ -80,6 +80,20 @@ namespace {
return !stillPassing(' ', true);
}
+ /**
+ * This function determines whether or not the given character
+ * is in the given character set.
+ *
+ * @param[in] c
+ * This is the character to check.
+ *
+ * @param[in] characterSet
+ * This is the set of characters that are allowed.
+ *
+ * @return
+ * An indication of whether or not the given character
+ * is in the given character set is returned.
+ */
bool IsCharacterInSet(
char c,
std::initializer_list< char > characterSet