summaryrefslogtreecommitdiff
path: root/include/hashcomp.h
diff options
context:
space:
mode:
authorbrain <brain@e03df62e-2008-0410-955e-edbf42e46eb7>2006-10-03 13:57:53 +0000
committerbrain <brain@e03df62e-2008-0410-955e-edbf42e46eb7>2006-10-03 13:57:53 +0000
commite25e200024db92c4584660e9d144902cfd4d626e (patch)
treed1157fbfde1356c4b2eb85c09187d3ff6e274a8d /include/hashcomp.h
parent9716d24be9e3e567308f6d144a65eeaccd65484a (diff)
Document
git-svn-id: http://svn.inspircd.org/repository/trunk/inspircd@5404 e03df62e-2008-0410-955e-edbf42e46eb7
Diffstat (limited to 'include/hashcomp.h')
-rw-r--r--include/hashcomp.h16
1 files changed, 16 insertions, 0 deletions
diff --git a/include/hashcomp.h b/include/hashcomp.h
index a99b5e76b..b22f65272 100644
--- a/include/hashcomp.h
+++ b/include/hashcomp.h
@@ -125,6 +125,9 @@ namespace irc
/** irc::stringjoiner joins string lists into a string, using
* the given seperator string.
+ * This class can join a vector of std::string, a deque of
+ * std::string, or a const char** array, using overloaded
+ * constructors.
*/
class stringjoiner
{
@@ -132,16 +135,29 @@ namespace irc
std::string joined;
public:
/** Join elements of a vector, between (and including) begin and end
+ * @param seperator The string to seperate values with
+ * @param sequence One or more items to seperate
+ * @param begin The starting element in the sequence to be joined
+ * @param end The ending element in the sequence to be joined
*/
stringjoiner(const std::string &seperator, const std::vector<std::string> &sequence, int begin, int end);
/** Join elements of a deque, between (and including) begin and end
+ * @param seperator The string to seperate values with
+ * @param sequence One or more items to seperate
+ * @param begin The starting element in the sequence to be joined
+ * @param end The ending element in the sequence to be joined
*/
stringjoiner(const std::string &seperator, const std::deque<std::string> &sequence, int begin, int end);
/** Join elements of an array of char arrays, between (and including) begin and end
+ * @param seperator The string to seperate values with
+ * @param sequence One or more items to seperate
+ * @param begin The starting element in the sequence to be joined
+ * @param end The ending element in the sequence to be joined
*/
stringjoiner(const std::string &seperator, const char** sequence, int begin, int end);
/** Get the joined sequence
+ * @return A reference to the joined string
*/
std::string& GetJoined();
};