From 364735e18b500f0a071fab4cc5c9e7bace1835fc Mon Sep 17 00:00:00 2001
From: brain <brain@e03df62e-2008-0410-955e-edbf42e46eb7>
Date: Fri, 6 Oct 2006 14:23:37 +0000
Subject: Document a ton of classes (e.g. give them a short description for
 http://svn.inspircd.org/docs/annotated.html)

git-svn-id: http://svn.inspircd.org/repository/trunk/inspircd@5434 e03df62e-2008-0410-955e-edbf42e46eb7
---
 include/commands/cmd_unloadmodule.h |  2 ++
 include/commands/cmd_user.h         |  2 ++
 include/hashcomp.h                  | 12 +++++++-----
 include/u_listmode.h                |  6 ++++++
 4 files changed, 17 insertions(+), 5 deletions(-)

(limited to 'include')

diff --git a/include/commands/cmd_unloadmodule.h b/include/commands/cmd_unloadmodule.h
index ba19bc5e1..c2d2d473d 100644
--- a/include/commands/cmd_unloadmodule.h
+++ b/include/commands/cmd_unloadmodule.h
@@ -22,6 +22,8 @@
 #include "users.h"
 #include "channels.h"
 
+/** Handle /UNLOADMODULE
+ */
 class cmd_unloadmodule : public command_t
 {
  public:
diff --git a/include/commands/cmd_user.h b/include/commands/cmd_user.h
index f5d7cb242..e7b9784bd 100644
--- a/include/commands/cmd_user.h
+++ b/include/commands/cmd_user.h
@@ -22,6 +22,8 @@
 #include "users.h"
 #include "channels.h"
 
+/** Handle /USER
+ */
 class cmd_user : public command_t
 {
  public:
diff --git a/include/hashcomp.h b/include/hashcomp.h
index b22f65272..b2756b340 100644
--- a/include/hashcomp.h
+++ b/include/hashcomp.h
@@ -248,10 +248,8 @@ namespace irc
 		const std::string GetToken();
 	};
 
-	/** irc::commasepstream allows for splitting comma seperated lists.
-	 * Lists passed to irc::commasepstream should not contain spaces
-	 * after the commas, or this will be taken to be part of the item
-	 * data. Each successive call to commasepstream::GetToken() returns
+	/** 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.
 	 */
@@ -263,7 +261,7 @@ namespace irc
 		std::string::iterator n;
 		char sep;
 	 public:
-		/** Create a commasepstream and fill it with the provided data
+		/** Create a sepstream and fill it with the provided data
 		 */
 		sepstream(const std::string &source, char seperator);
 		virtual ~sepstream();
@@ -274,6 +272,8 @@ namespace irc
 		virtual const std::string GetToken();
 	};
 
+	/** A derived form of sepstream, which seperates on commas
+	 */
 	class commasepstream : public sepstream
 	{
 	 public:
@@ -282,6 +282,8 @@ namespace irc
 		}
 	};
 
+	/** A derived form of sepstream, which seperates on spaces
+	 */
 	class spacesepstream : public sepstream
 	{
 	 public:
diff --git a/include/u_listmode.h b/include/u_listmode.h
index 8315dbcd1..d5416988a 100644
--- a/include/u_listmode.h
+++ b/include/u_listmode.h
@@ -27,6 +27,8 @@ inline std::string stringtime()
 	return TIME.str();
 }
 
+/** An item in a listmode's list
+ */
 class ListItem : public classbase
 {
 public:
@@ -35,6 +37,8 @@ public:
 	std::string time;
 };
 
+/** The number of items a listmode's list may contain
+ */
 class ListLimit : public classbase
 {
 public:
@@ -46,6 +50,8 @@ public:
 typedef std::vector<ListItem> modelist;
 typedef std::vector<ListLimit> limitlist;
 
+/** The base class for listmodes defined by u_listmode.h
+ */
 class ListModeBase : public ModeHandler
 {
  protected:
-- 
cgit v1.2.3