diff options
| author | Attila Molnar <attilamolnar@hush.com> | 2016-08-22 17:22:19 +0200 |
|---|---|---|
| committer | Attila Molnar <attilamolnar@hush.com> | 2016-08-22 17:22:19 +0200 |
| commit | 0aa6c4134011006e6166c72d9c3162b054c01bbe (patch) | |
| tree | fe0c0962384f5f8aa83658fd5897aa13e29ce22e | |
| parent | 333fe87ca7cbf66ec2468f726054180a0fe85316 (diff) | |
Update documentation in hashcomp.h
| -rw-r--r-- | include/hashcomp.h | 14 |
1 files changed, 6 insertions, 8 deletions
diff --git a/include/hashcomp.h b/include/hashcomp.h index 8856d81bb..f3b1ba6e9 100644 --- a/include/hashcomp.h +++ b/include/hashcomp.h @@ -40,11 +40,9 @@ * treat [ identical to {, ] identical to }, and \ * as identical to |. * - * Our hashing functions are designed to accept - * std::string and compare/hash them as type irc::string - * by converting them internally. This makes them - * backwards compatible with other code which is not - * aware of irc::string. + * There are functors that accept std::string and + * compare/hash them as type irc::string by using + * mapping arrays internally. *******************************************************/ /** Seperate from the other casemap tables so that code *can* still exclusively rely on RFC casemapping @@ -74,7 +72,6 @@ CoreExport extern unsigned const char rfc_case_sensitive_map[256]; */ namespace irc { - /** Check if two IRC object (e.g. nick or channel) names are equal. * This function uses national_case_insensitive_map to determine equality, which, by default does comparison * according to RFC 1459, treating certain otherwise non-identical characters as identical. @@ -159,14 +156,15 @@ namespace irc /** Joins the contents of a vector to a string. * @param sequence Zero or more items to join. - * @separator The character to place between the items. + * @param separator The character to place between the items, defaults to ' ' (space). + * @return Joined string. */ std::string CoreExport stringjoiner(const std::vector<std::string>& sequence, char separator = ' '); /** irc::sepstream allows for splitting token seperated lists. * Each successive call to sepstream::GetToken() returns * the next token, until none remain, at which point the method returns - * an empty string. + * false. */ class CoreExport sepstream { |