From 855f0d98e90a077f46b456e98ebb8a9b290488f6 Mon Sep 17 00:00:00 2001 From: brain Date: Fri, 6 Oct 2006 14:37:51 +0000 Subject: Document more classes git-svn-id: http://svn.inspircd.org/repository/trunk/inspircd@5435 e03df62e-2008-0410-955e-edbf42e46eb7 --- src/modules/extra/m_mysql.cpp | 11 ++++++++++- src/modules/extra/m_pgsql.cpp | 2 ++ src/modules/m_ident.cpp | 2 ++ src/modules/m_randquote.cpp | 2 ++ src/modules/m_redirect.cpp | 2 ++ src/modules/m_showwhois.cpp | 5 ++--- src/modules/m_spanningtree.cpp | 4 ++++ src/modules/m_sslmodes.cpp | 2 ++ src/modules/m_stripcolor.cpp | 2 ++ src/modules/m_watch.cpp | 8 ++++---- 10 files changed, 32 insertions(+), 8 deletions(-) (limited to 'src/modules') diff --git a/src/modules/extra/m_mysql.cpp b/src/modules/extra/m_mysql.cpp index a59ad3b6c..c9d926e65 100644 --- a/src/modules/extra/m_mysql.cpp +++ b/src/modules/extra/m_mysql.cpp @@ -23,7 +23,6 @@ using namespace std; #include "users.h" #include "channels.h" #include "modules.h" - #include "inspircd.h" #include "m_sqlv2.h" @@ -85,6 +84,8 @@ int QueueFD = -1; typedef std::deque ResultQueue; +/** Represents a mysql query queue + */ class QueryQueue : public classbase { private: @@ -198,6 +199,8 @@ pthread_mutex_t queue_mutex = PTHREAD_MUTEX_INITIALIZER; pthread_mutex_t results_mutex = PTHREAD_MUTEX_INITIALIZER; +/** Represents a mysql result set + */ class MySQLresult : public SQLresult { int currentrow; @@ -383,6 +386,8 @@ class SQLConnection; void NotifyMainThread(SQLConnection* connection_with_new_result); +/** Represents a connection to a mysql database + */ class SQLConnection : public classbase { protected: @@ -638,6 +643,8 @@ void NotifyMainThread(SQLConnection* connection_with_new_result) void* DispatcherThread(void* arg); +/** Used by m_mysql to notify one thread when the other has a result + */ class Notifier : public InspSocket { insp_sockaddr sock_us; @@ -711,6 +718,8 @@ class Notifier : public InspSocket } }; +/** MySQL module + */ class ModuleSQL : public Module { public: diff --git a/src/modules/extra/m_pgsql.cpp b/src/modules/extra/m_pgsql.cpp index 4e316b9ec..b4cba6a7a 100644 --- a/src/modules/extra/m_pgsql.cpp +++ b/src/modules/extra/m_pgsql.cpp @@ -87,6 +87,8 @@ class SQLhost } }; +/** Used to resolve sql server hostnames + */ class SQLresolver : public Resolver { private: diff --git a/src/modules/m_ident.cpp b/src/modules/m_ident.cpp index 040e856d4..2cccc57b4 100644 --- a/src/modules/m_ident.cpp +++ b/src/modules/m_ident.cpp @@ -27,6 +27,8 @@ using namespace std; // Version 1.5.0.0 - Updated to use InspSocket, faster and neater. +/** Handles RFC1413 ident connections to users + */ class RFC1413 : public InspSocket { protected: diff --git a/src/modules/m_randquote.cpp b/src/modules/m_randquote.cpp index 519fb5b93..bcf98b5f3 100644 --- a/src/modules/m_randquote.cpp +++ b/src/modules/m_randquote.cpp @@ -61,6 +61,8 @@ class cmd_randquote : public command_t } }; +/** Thrown by m_randquote + */ class RandquoteException : public ModuleException { private: diff --git a/src/modules/m_redirect.cpp b/src/modules/m_redirect.cpp index cf118ca3c..54cba0ed7 100644 --- a/src/modules/m_redirect.cpp +++ b/src/modules/m_redirect.cpp @@ -23,6 +23,8 @@ using namespace std; /* $ModDesc: Provides channel mode +L (limit redirection) */ +/** Handle channel mode +L + */ class Redirect : public ModeHandler { public: diff --git a/src/modules/m_showwhois.cpp b/src/modules/m_showwhois.cpp index 42fe2f45b..85a16bc93 100644 --- a/src/modules/m_showwhois.cpp +++ b/src/modules/m_showwhois.cpp @@ -6,13 +6,12 @@ using namespace std; #include "users.h" #include "channels.h" #include "modules.h" - #include "inspircd.h" /* $ModDesc: Allows opers to set +W to see when a user uses WHOIS on them */ - - +/** Handle user mode +W + */ class SeeWhois : public ModeHandler { public: diff --git a/src/modules/m_spanningtree.cpp b/src/modules/m_spanningtree.cpp index c02c31ac4..efd01b141 100644 --- a/src/modules/m_spanningtree.cpp +++ b/src/modules/m_spanningtree.cpp @@ -119,6 +119,8 @@ bool AnnounceTSChange; std::vector ValidIPs; +/** This will be used in a future version of InspIRCd for UID support + */ class UserManager : public classbase { uid_hash uids; @@ -3514,6 +3516,8 @@ class ServernameResolver : public Resolver } }; +/** Handle resolving of server IPs for the cache + */ class SecurityIPResolver : public Resolver { private: diff --git a/src/modules/m_sslmodes.cpp b/src/modules/m_sslmodes.cpp index b2d86fe44..55aa06fd4 100644 --- a/src/modules/m_sslmodes.cpp +++ b/src/modules/m_sslmodes.cpp @@ -23,6 +23,8 @@ static char* dummy; +/** Handle channel mode +z + */ class SSLMode : public ModeHandler { public: diff --git a/src/modules/m_stripcolor.cpp b/src/modules/m_stripcolor.cpp index 7e4cf6e0e..976be2b5c 100644 --- a/src/modules/m_stripcolor.cpp +++ b/src/modules/m_stripcolor.cpp @@ -57,6 +57,8 @@ class ChannelStripColor : public ModeHandler } }; +/** Handles user mode +S + */ class UserStripColor : public ModeHandler { public: diff --git a/src/modules/m_watch.cpp b/src/modules/m_watch.cpp index ed56f7b8b..5ca114e0c 100644 --- a/src/modules/m_watch.cpp +++ b/src/modules/m_watch.cpp @@ -22,15 +22,13 @@ using namespace std; #include "users.h" #include "channels.h" #include "modules.h" - #include "hashcomp.h" #include "inspircd.h" /* $ModDesc: Provides support for the /watch command */ - - - +/** A watchlist entry + */ class watchentry : public classbase { public: @@ -41,6 +39,8 @@ class watchentry : public classbase typedef std::vector watchlist; watchlist watches; +/** Handle /WATCH + */ class cmd_watch : public command_t { public: -- cgit v1.2.3