diff options
author | brain <brain@e03df62e-2008-0410-955e-edbf42e46eb7> | 2006-10-06 14:23:37 +0000 |
---|---|---|
committer | brain <brain@e03df62e-2008-0410-955e-edbf42e46eb7> | 2006-10-06 14:23:37 +0000 |
commit | 364735e18b500f0a071fab4cc5c9e7bace1835fc (patch) | |
tree | b5235b72d84aa823ea32512eb820840930f99184 /include/u_listmode.h | |
parent | a519f21f44dbbaf30b90fe44a9a73f930d61c185 (diff) |
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
Diffstat (limited to 'include/u_listmode.h')
-rw-r--r-- | include/u_listmode.h | 6 |
1 files changed, 6 insertions, 0 deletions
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: |