Comments describing classes, for the url http://svn.inspircd.org/docs/annotated.html

git-svn-id: http://svn.inspircd.org/repository/trunk/inspircd@5251 e03df62e-2008-0410-955e-edbf42e46eb7

1 files changed, 12 insertions, 0 deletions

diff --git a/src/modules/m_services.cpp b/src/modules/m_services.cpp
index 63f04287a..7e3a8d89b 100644
--- a/src/modules/m_services.cpp
+++ b/src/modules/m_services.cpp
@@ -25,6 +25,8 @@ static bool kludgeme = false;
 
 /* $ModDesc: Povides support for services +r user/chan modes and more */
 
+/** Channel mode +r - mark a channel as identified
+ */
 class Channel_r : public ModeHandler
 {
 	
@@ -49,6 +51,8 @@ class Channel_r : public ModeHandler
 	}
 };
 
+/** User mode +r - mark a user as identified
+ */
 class User_r : public ModeHandler
 {
 	
@@ -72,6 +76,8 @@ class User_r : public ModeHandler
 	}
 };
 
+/** Channel mode +R - registered users only
+ */
 class Channel_R : public ModeHandler
 {
  public:
@@ -100,6 +106,8 @@ class Channel_R : public ModeHandler
 	}
 };
 
+/** User mode +R - only allow PRIVMSG and NOTICE from registered users
+ */
 class User_R : public ModeHandler
 {
  public:
@@ -128,6 +136,8 @@ class User_R : public ModeHandler
 	}
 };
 
+/** Channel mode +M - only allow privmsg and notice to channel from registered users
+ */
 class Channel_M : public ModeHandler
 {
  public:
@@ -156,6 +166,8 @@ class Channel_M : public ModeHandler
 	}
 };
 
+/** Dreamnforge-like services support
+ */
 class ModuleServices : public Module
 {