Added new module docs

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

1 files changed, 138 insertions, 138 deletions

diff --git a/docs/man/man3/ConfigReader.3 b/docs/man/man3/ConfigReader.3
index abbec6ef3..6edd9f6fa 100644
--- a/docs/man/man3/ConfigReader.3
+++ b/docs/man/man3/ConfigReader.3
@@ -1,4 +1,4 @@
-.TH "ConfigReader" 3 "27 Nov 2005" "Version 1.0Betareleases" "InspIRCd" \" -*- nroff -*-
+.TH "ConfigReader" 3 "9 Dec 2005" "Version 1.0Betareleases" "InspIRCd" \" -*- nroff -*-
 .ad l
 .nh
 .SH NAME
@@ -84,7 +84,7 @@ Allows reading of values from configuration files This class allows a module to
 
 It may either be instantiated with one parameter or none. Constructing the class using one parameter allows you to specify a path to your own configuration file, otherwise, inspircd.conf is read.
 .PP
-Definition at line 1121 of file modules.h.
+Definition at line 1510 of file modules.h.
 .SH "Constructor & Destructor Documentation"
 .PP 
 .SS "ConfigReader::ConfigReader ()"
@@ -93,19 +93,19 @@ Default constructor.
 .PP
 This constructor initialises the ConfigReader class to read the inspircd.conf file as specified when running ./configure.
 .PP
-Definition at line 796 of file modules.cpp.
+Definition at line 834 of file modules.cpp.
 .PP
 References cache, CONF_FILE_NOT_FOUND, error, errorlog, include_stack, and readerror.
 .PP
 .nf
-797 {
-798         include_stack.clear();
-799         this->cache = new std::stringstream(std::stringstream::in | std::stringstream::out);
-800         this->errorlog = new std::stringstream(std::stringstream::in | std::stringstream::out);
-801         this->readerror = LoadConf(CONFIG_FILE,this->cache,this->errorlog);
-802         if (!this->readerror)
-803                 this->error = CONF_FILE_NOT_FOUND;
-804 }
+835 {
+836         include_stack.clear();
+837         this->cache = new std::stringstream(std::stringstream::in | std::stringstream::out);
+838         this->errorlog = new std::stringstream(std::stringstream::in | std::stringstream::out);
+839         this->readerror = LoadConf(CONFIG_FILE,this->cache,this->errorlog);
+840         if (!this->readerror)
+841                 this->error = CONF_FILE_NOT_FOUND;
+842 }
 .fi
 .PP
 .SS "ConfigReader::ConfigReader (\fBstd::string\fP filename)"
@@ -114,18 +114,18 @@ Overloaded constructor.
 .PP
 This constructor initialises the ConfigReader class to read a user-specified config file
 .PP
-Definition at line 816 of file modules.cpp.
+Definition at line 854 of file modules.cpp.
 .PP
 References cache, CONF_FILE_NOT_FOUND, error, errorlog, and readerror.
 .PP
 .nf
-817 {
-818         this->cache = new std::stringstream(std::stringstream::in | std::stringstream::out);
-819         this->errorlog = new std::stringstream(std::stringstream::in | std::stringstream::out);
-820         this->readerror = LoadConf(filename.c_str(),this->cache,this->errorlog);
-821         if (!this->readerror)
-822                 this->error = CONF_FILE_NOT_FOUND;
-823 };
+855 {
+856         this->cache = new std::stringstream(std::stringstream::in | std::stringstream::out);
+857         this->errorlog = new std::stringstream(std::stringstream::in | std::stringstream::out);
+858         this->readerror = LoadConf(filename.c_str(),this->cache,this->errorlog);
+859         if (!this->readerror)
+860                 this->error = CONF_FILE_NOT_FOUND;
+861 };
 .fi
 .PP
 .SS "ConfigReader::~ConfigReader ()"
@@ -134,17 +134,17 @@ Default destructor.
 .PP
 This method destroys the ConfigReader class.
 .PP
-Definition at line 807 of file modules.cpp.
+Definition at line 845 of file modules.cpp.
 .PP
 References cache, and errorlog.
 .PP
 .nf
-808 {
-809         if (this->cache)
-810                 delete this->cache;
-811         if (this->errorlog)
-812                 delete this->errorlog;
-813 }
+846 {
+847         if (this->cache)
+848                 delete this->cache;
+849         if (this->errorlog)
+850                 delete this->errorlog;
+851 }
 .fi
 .PP
 .SH "Member Function Documentation"
@@ -155,41 +155,41 @@ Dumps the list of errors in a config file to an output location.
 .PP
 If bail is true, then the program will abort. If bail is false and user points to a valid user record, the error report will be spooled to the given user by means of NOTICE. if bool is false AND user is false, the error report will be spooled to all opers by means of a NOTICE to all opers.
 .PP
-Definition at line 894 of file modules.cpp.
+Definition at line 932 of file modules.cpp.
 .PP
 References errorlog, connection::fd, and userrec::nick.
 .PP
 .nf
-895 {
-896         if (bail)
-897         {
-898                 printf('There were errors in your configuration:\n%s',errorlog->str().c_str());
-899                 exit(0);
-900         }
-901         else
-902         {
-903                 char dataline[1024];
-904                 if (user)
-905                 {
-906                         WriteServ(user->fd,'NOTICE %s :There were errors in the configuration file:',user->nick);
-907                         while (!errorlog->eof())
-908                         {
-909                                 errorlog->getline(dataline,1024);
-910                                 WriteServ(user->fd,'NOTICE %s :%s',user->nick,dataline);
-911                         }
-912                 }
-913                 else
-914                 {
-915                         WriteOpers('There were errors in the configuration file:',user->nick);
-916                         while (!errorlog->eof())
-917                         {
-918                                 errorlog->getline(dataline,1024);
-919                                 WriteOpers(dataline);
-920                         }
-921                 }
-922                 return;
-923         }
-924 }
+933 {
+934         if (bail)
+935         {
+936                 printf('There were errors in your configuration:\n%s',errorlog->str().c_str());
+937                 exit(0);
+938         }
+939         else
+940         {
+941                 char dataline[1024];
+942                 if (user)
+943                 {
+944                         WriteServ(user->fd,'NOTICE %s :There were errors in the configuration file:',user->nick);
+945                         while (!errorlog->eof())
+946                         {
+947                                 errorlog->getline(dataline,1024);
+948                                 WriteServ(user->fd,'NOTICE %s :%s',user->nick,dataline);
+949                         }
+950                 }
+951                 else
+952                 {
+953                         WriteOpers('There were errors in the configuration file:',user->nick);
+954                         while (!errorlog->eof())
+955                         {
+956                                 errorlog->getline(dataline,1024);
+957                                 WriteOpers(dataline);
+958                         }
+959                 }
+960                 return;
+961         }
+962 }
 .fi
 .PP
 .SS "int ConfigReader::Enumerate (\fBstd::string\fP tag)"
@@ -198,14 +198,14 @@ Counts the number of times a given tag appears in the config file.
 .PP
 This method counts the number of times a tag appears in a config file, for use where there are several tags of the same kind, e.g. with opers and connect types. It can be used with the index value of \fBConfigReader::ReadValue\fP to loop through all copies of a multiple instance tag.
 .PP
-Definition at line 927 of file modules.cpp.
+Definition at line 965 of file modules.cpp.
 .PP
 References cache.
 .PP
 .nf
-928 {
-929         return EnumConf(cache,tag.c_str());
-930 }
+966 {
+967         return EnumConf(cache,tag.c_str());
+968 }
 .fi
 .PP
 .SS "int ConfigReader::EnumerateValues (\fBstd::string\fP tag, int index)"
@@ -214,14 +214,14 @@ Returns the number of items within a tag.
 .PP
 For example if the tag was <test tag='blah' data='foo'> then this function would return 2. Spaces and newlines both qualify as valid seperators between values.
 .PP
-Definition at line 932 of file modules.cpp.
+Definition at line 970 of file modules.cpp.
 .PP
 References cache.
 .PP
 .nf
-933 {
-934         return EnumValues(cache, tag.c_str(), index);
-935 }
+971 {
+972         return EnumValues(cache, tag.c_str(), index);
+973 }
 .fi
 .PP
 .SS "long ConfigReader::GetError ()"
@@ -230,16 +230,16 @@ Returns the last error to occur.
 .PP
 Valid errors can be found by looking in \fBmodules.h\fP. Any nonzero value indicates an error condition. A call to \fBGetError()\fP resets the error flag back to 0.
 .PP
-Definition at line 887 of file modules.cpp.
+Definition at line 925 of file modules.cpp.
 .PP
 References error.
 .PP
 .nf
-888 {
-889         long olderr = this->error;
-890         this->error = 0;
-891         return olderr;
-892 }
+926 {
+927         long olderr = this->error;
+928         this->error = 0;
+929         return olderr;
+930 }
 .fi
 .PP
 .SS "bool ConfigReader::ReadFlag (\fBstd::string\fP tag, \fBstd::string\fP name, int index)"
@@ -248,26 +248,26 @@ Retrieves a boolean value from the config file.
 .PP
 This method retrieves a boolean value from the config file. Where multiple copies of the tag exist in the config file, index indicates which of the values to retrieve. The values '1', 'yes' and 'true' in the config file count as true to ReadFlag, and any other value counts as false.
 .PP
-Definition at line 841 of file modules.cpp.
+Definition at line 879 of file modules.cpp.
 .PP
 References cache, CONF_VALUE_NOT_FOUND, and error.
 .PP
 .nf
-842 {
-843         char val[MAXBUF];
-844         char t[MAXBUF];
-845         char n[MAXBUF];
-846         strlcpy(t,tag.c_str(),MAXBUF);
-847         strlcpy(n,name.c_str(),MAXBUF);
-848         int res = ReadConf(cache,t,n,index,val);
-849         if (!res)
-850         {
-851                 this->error = CONF_VALUE_NOT_FOUND;
-852                 return false;
-853         }
-854         std::string s = val;
-855         return ((s == 'yes') || (s == 'YES') || (s == 'true') || (s == 'TRUE') || (s == '1'));
-856 }
+880 {
+881         char val[MAXBUF];
+882         char t[MAXBUF];
+883         char n[MAXBUF];
+884         strlcpy(t,tag.c_str(),MAXBUF);
+885         strlcpy(n,name.c_str(),MAXBUF);
+886         int res = ReadConf(cache,t,n,index,val);
+887         if (!res)
+888         {
+889                 this->error = CONF_VALUE_NOT_FOUND;
+890                 return false;
+891         }
+892         std::string s = val;
+893         return ((s == 'yes') || (s == 'YES') || (s == 'true') || (s == 'TRUE') || (s == '1'));
+894 }
 .fi
 .PP
 .SS "long ConfigReader::ReadInteger (\fBstd::string\fP tag, \fBstd::string\fP name, int index, bool needs_unsigned)"
@@ -276,38 +276,38 @@ Retrieves an integer value from the config file.
 .PP
 This method retrieves an integer value from the config file. Where multiple copies of the tag exist in the config file, index indicates which of the values to retrieve. Any invalid integer values in the tag will cause the objects error value to be set, and any call to \fBGetError()\fP will return CONF_INVALID_NUMBER to be returned. needs_unsigned is set if the number must be unsigned. If a signed number is placed into a tag which is specified unsigned, 0 will be returned and \fBGetError()\fP will return CONF_NOT_UNSIGNED
 .PP
-Definition at line 858 of file modules.cpp.
+Definition at line 896 of file modules.cpp.
 .PP
 References cache, CONF_NOT_A_NUMBER, CONF_NOT_UNSIGNED, CONF_VALUE_NOT_FOUND, and error.
 .PP
 .nf
-859 {
-860         char val[MAXBUF];
-861         char t[MAXBUF];
-862         char n[MAXBUF];
-863         strlcpy(t,tag.c_str(),MAXBUF);
-864         strlcpy(n,name.c_str(),MAXBUF);
-865         int res = ReadConf(cache,t,n,index,val);
-866         if (!res)
-867         {
-868                 this->error = CONF_VALUE_NOT_FOUND;
-869                 return 0;
-870         }
-871         for (unsigned int i = 0; i < strlen(val); i++)
-872         {
-873                 if (!isdigit(val[i]))
-874                 {
-875                         this->error = CONF_NOT_A_NUMBER;
-876                         return 0;
-877                 }
-878         }
-879         if ((needs_unsigned) && (atoi(val)<0))
-880         {
-881                 this->error = CONF_NOT_UNSIGNED;
-882                 return 0;
-883         }
-884         return atoi(val);
-885 }
+897 {
+898         char val[MAXBUF];
+899         char t[MAXBUF];
+900         char n[MAXBUF];
+901         strlcpy(t,tag.c_str(),MAXBUF);
+902         strlcpy(n,name.c_str(),MAXBUF);
+903         int res = ReadConf(cache,t,n,index,val);
+904         if (!res)
+905         {
+906                 this->error = CONF_VALUE_NOT_FOUND;
+907                 return 0;
+908         }
+909         for (unsigned int i = 0; i < strlen(val); i++)
+910         {
+911                 if (!isdigit(val[i]))
+912                 {
+913                         this->error = CONF_NOT_A_NUMBER;
+914                         return 0;
+915                 }
+916         }
+917         if ((needs_unsigned) && (atoi(val)<0))
+918         {
+919                 this->error = CONF_NOT_UNSIGNED;
+920                 return 0;
+921         }
+922         return atoi(val);
+923 }
 .fi
 .PP
 .SS "\fBstd::string\fP ConfigReader::ReadValue (\fBstd::string\fP tag, \fBstd::string\fP name, int index)"
@@ -316,25 +316,25 @@ Retrieves a value from the config file.
 .PP
 This method retrieves a value from the config file. Where multiple copies of the tag exist in the config file, index indicates which of the values to retrieve.
 .PP
-Definition at line 825 of file modules.cpp.
+Definition at line 863 of file modules.cpp.
 .PP
 References cache, CONF_VALUE_NOT_FOUND, and error.
 .PP
 .nf
-826 {
-827         char val[MAXBUF];
-828         char t[MAXBUF];
-829         char n[MAXBUF];
-830         strlcpy(t,tag.c_str(),MAXBUF);
-831         strlcpy(n,name.c_str(),MAXBUF);
-832         int res = ReadConf(cache,t,n,index,val);
-833         if (!res)
-834         {
-835                 this->error = CONF_VALUE_NOT_FOUND;
-836                 return '';
-837         }
-838         return val;
-839 }
+864 {
+865         char val[MAXBUF];
+866         char t[MAXBUF];
+867         char n[MAXBUF];
+868         strlcpy(t,tag.c_str(),MAXBUF);
+869         strlcpy(n,name.c_str(),MAXBUF);
+870         int res = ReadConf(cache,t,n,index,val);
+871         if (!res)
+872         {
+873                 this->error = CONF_VALUE_NOT_FOUND;
+874                 return '';
+875         }
+876         return val;
+877 }
 .fi
 .PP
 .SS "bool ConfigReader::Verify ()"
@@ -343,14 +343,14 @@ Returns true if a config file is valid.
 .PP
 This method is partially implemented and will only return false if the config file does not exist or could not be opened.
 .PP
-Definition at line 937 of file modules.cpp.
+Definition at line 975 of file modules.cpp.
 .PP
 References readerror.
 .PP
 .nf
-938 {
-939         return this->readerror;
-940 }
+976 {
+977         return this->readerror;
+978 }
 .fi
 .PP
 .SH "Member Data Documentation"
@@ -361,24 +361,24 @@ The contents of the configuration file This protected member should never be acc
 .PP
 It will contain a pointer to the configuration file data with unneeded data (such as comments) stripped from it.
 .PP
-Definition at line 1129 of file modules.h.
+Definition at line 1518 of file modules.h.
 .PP
 Referenced by ConfigReader(), Enumerate(), EnumerateValues(), ReadFlag(), ReadInteger(), ReadValue(), and ~ConfigReader().
 .SS "long \fBConfigReader::error\fP\fC [protected]\fP"
 .PP
-Definition at line 1134 of file modules.h.
+Definition at line 1523 of file modules.h.
 .PP
 Referenced by ConfigReader(), GetError(), ReadFlag(), ReadInteger(), and ReadValue().
 .SS "std::stringstream* \fBConfigReader::errorlog\fP\fC [protected]\fP"
 .PP
-Definition at line 1130 of file modules.h.
+Definition at line 1519 of file modules.h.
 .PP
 Referenced by ConfigReader(), DumpErrors(), and ~ConfigReader().
 .SS "bool \fBConfigReader::readerror\fP\fC [protected]\fP"
 .PP
 Used to store errors. 
 .PP
-Definition at line 1133 of file modules.h.
+Definition at line 1522 of file modules.h.
 .PP
 Referenced by ConfigReader(), and Verify().