diff options
| author | brain <brain@e03df62e-2008-0410-955e-edbf42e46eb7> | 2005-05-15 17:05:15 +0000 |
|---|---|---|
| committer | brain <brain@e03df62e-2008-0410-955e-edbf42e46eb7> | 2005-05-15 17:05:15 +0000 |
| commit | 4d5a17380bc71cabe544b41c7c8a26a292384f3d (patch) | |
| tree | 9a882bc421d4c250817a17980265b76e06e4cf8c /docs/module-doc/annotated.html | |
| parent | a48ee868ed80b689b773fdd9bbd8f1e761dc3b8a (diff) | |
Added docs for hashcomp
git-svn-id: http://svn.inspircd.org/repository/trunk/inspircd@1396 e03df62e-2008-0410-955e-edbf42e46eb7
Diffstat (limited to 'docs/module-doc/annotated.html')
| -rw-r--r-- | docs/module-doc/annotated.html | 10 |
1 files changed, 6 insertions, 4 deletions
diff --git a/docs/module-doc/annotated.html b/docs/module-doc/annotated.html index ebb8d5dd2..c72a198b1 100644 --- a/docs/module-doc/annotated.html +++ b/docs/module-doc/annotated.html @@ -4,11 +4,12 @@ <link href="inspircd.doxygen.css" rel="stylesheet" type="text/css"> </head><body> <!-- Generated by Doxygen 1.3.3 --> -<div class="qindex"><a class="qindex" href="main.html">Main Page</a> | <a class="qindex" href="namespaces.html">Namespace List</a> | <a class="qindex" href="hierarchy.html">Class Hierarchy</a> | <a class="qindex" href="classes.html">Alphabetical List</a> | <a class="qindexHL" href="annotated.html">Compound List</a> | <a class="qindex" href="files.html">File List</a> | <a class="qindex" href="functions.html">Compound Members</a> | <a class="qindex" href="globals.html">File Members</a></div> +<div class="qindex"><a class="qindex" href="main.html">Main Page</a> | <a class="qindex" href="namespaces.html">Namespace List</a> | <a class="qindex" href="hierarchy.html">Class Hierarchy</a> | <a class="qindex" href="classes.html">Alphabetical List</a> | <a class="qindexHL" href="annotated.html">Compound List</a> | <a class="qindex" href="files.html">File List</a> | <a class="qindex" href="namespacemembers.html">Namespace Members</a> | <a class="qindex" href="functions.html">Compound Members</a> | <a class="qindex" href="globals.html">File Members</a></div> <h1>InspIRCd Compound List</h1>Here are the classes, structs, unions and interfaces with brief descriptions:<table> <tr><td class="indexkey"><a class="el" href="classAdmin.html">Admin</a></td><td class="indexvalue">Holds /ADMIN data This class contains the admin details of the local server </td></tr> <tr><td class="indexkey"><a class="el" href="classBanItem.html">BanItem</a></td><td class="indexvalue">A subclass of <a class="el" href="classHostItem.html">HostItem</a> designed to hold channel bans (+b) </td></tr> <tr><td class="indexkey"><a class="el" href="classchanrec.html">chanrec</a></td><td class="indexvalue">Holds all relevent information for a channel </td></tr> + <tr><td class="indexkey"><a class="el" href="classstd_1_1char__traits.html">char_traits</a></td><td class="indexvalue"></td></tr> <tr><td class="indexkey"><a class="el" href="classclassbase.html">classbase</a></td><td class="indexvalue">The base class for all inspircd classes </td></tr> <tr><td class="indexkey"><a class="el" href="classcommand__t.html">command_t</a></td><td class="indexvalue">A structure that defines a command </td></tr> <tr><td class="indexkey"><a class="el" href="classConfigReader.html">ConfigReader</a></td><td class="indexvalue">Allows reading of values from configuration files This class allows a module to read from either the main configuration file (inspircd.conf) or from a module-specified configuration file </td></tr> @@ -24,9 +25,10 @@ <tr><td class="indexkey"><a class="el" href="classFileReader.html">FileReader</a></td><td class="indexvalue">Caches a text file into memory and can be used to retrieve lines from it </td></tr> <tr><td class="indexkey"><a class="el" href="classGLine.html">GLine</a></td><td class="indexvalue">GLine class </td></tr> <tr><td class="indexkey"><a class="el" href="classHostItem.html">HostItem</a></td><td class="indexvalue">Holds an entry for a ban list, exemption list, or invite list </td></tr> - <tr><td class="indexkey"><a class="el" href="structInAddr__HashComp.html">InAddr_HashComp</a></td><td class="indexvalue"></td></tr> + <tr><td class="indexkey"><a class="el" href="structInAddr__HashComp.html">InAddr_HashComp</a></td><td class="indexvalue">This class returns true if two in_addr structs match </td></tr> <tr><td class="indexkey"><a class="el" href="classInvited.html">Invited</a></td><td class="indexvalue">Holds a channel name to which a user has been invited </td></tr> <tr><td class="indexkey"><a class="el" href="classInviteItem.html">InviteItem</a></td><td class="indexvalue">A subclass of <a class="el" href="classHostItem.html">HostItem</a> designed to hold channel invites (+I) </td></tr> + <tr><td class="indexkey"><a class="el" href="structirc_1_1irc__char__traits.html">irc::irc_char_traits</a></td><td class="indexvalue">The <a class="el" href="structirc_1_1irc__char__traits.html">irc_char_traits</a> class is used for RFC-style comparison of strings </td></tr> <tr><td class="indexkey"><a class="el" href="classircd__connector.html">ircd_connector</a></td><td class="indexvalue">Each connection has one or more of these each represents ONE outbound connection to another ircd so each inbound has multiple outbounds </td></tr> <tr><td class="indexkey"><a class="el" href="classKLine.html">KLine</a></td><td class="indexvalue">KLine class </td></tr> <tr><td class="indexkey"><a class="el" href="classModeParameter.html">ModeParameter</a></td><td class="indexvalue">Holds a custom parameter to a module-defined channel mode e.g </td></tr> @@ -39,7 +41,7 @@ <tr><td class="indexkey"><a class="el" href="classRequest.html">Request</a></td><td class="indexvalue">Unicast message directed at a given module </td></tr> <tr><td class="indexkey"><a class="el" href="classServer.html">Server</a></td><td class="indexvalue">Allows server output and query functions This class contains methods which allow a module to query the state of the irc server, and produce output to users and other servers </td></tr> <tr><td class="indexkey"><a class="el" href="classserverrec.html">serverrec</a></td><td class="indexvalue">A class that defines the local server or a remote server </td></tr> - <tr><td class="indexkey"><a class="el" href="structStrHashComp.html">StrHashComp</a></td><td class="indexvalue"></td></tr> + <tr><td class="indexkey"><a class="el" href="structStrHashComp.html">StrHashComp</a></td><td class="indexvalue">This class returns true if two strings match </td></tr> <tr><td class="indexkey"><a class="el" href="classucrec.html">ucrec</a></td><td class="indexvalue">Holds a user's modes on a channel This class associates a users privilages with a channel by creating a pointer link between a userrec and chanrec class </td></tr> <tr><td class="indexkey"><a class="el" href="classuserrec.html">userrec</a></td><td class="indexvalue">Holds all information about a user This class stores all information about a user connected to the irc server </td></tr> <tr><td class="indexkey"><a class="el" href="classVersion.html">Version</a></td><td class="indexvalue">Holds a module's Version information The four members (set by the constructor only) indicate details as to the version number of a module </td></tr> @@ -47,7 +49,7 @@ <tr><td class="indexkey"><a class="el" href="classXLine.html">XLine</a></td><td class="indexvalue">XLine is the base class for ban lines such as G lines and K lines </td></tr> <tr><td class="indexkey"><a class="el" href="classZLine.html">ZLine</a></td><td class="indexvalue">ZLine class </td></tr> </table> -<hr size="1"><address style="align: right;"><small>Generated on Fri May 13 15:49:18 2005 for InspIRCd by +<hr size="1"><address style="align: right;"><small>Generated on Sun May 15 17:02:54 2005 for InspIRCd by <a href="http://www.doxygen.org/index.html"> <img src="doxygen.png" alt="doxygen" align="middle" border=0 > </a>1.3.3 </small></address> |