From f62de63955ff77e800360eb140f108b5d2c6c075 Mon Sep 17 00:00:00 2001 From: brain Date: Mon, 19 Dec 2005 18:32:09 +0000 Subject: Design flaw my ass. git-svn-id: http://svn.inspircd.org/repository/trunk/inspircd@2580 e03df62e-2008-0410-955e-edbf42e46eb7 --- docs/module-doc/classCullItem.html | 208 ------------------------------------- 1 file changed, 208 deletions(-) delete mode 100644 docs/module-doc/classCullItem.html (limited to 'docs/module-doc/classCullItem.html') diff --git a/docs/module-doc/classCullItem.html b/docs/module-doc/classCullItem.html deleted file mode 100644 index 06900037c..000000000 --- a/docs/module-doc/classCullItem.html +++ /dev/null @@ -1,208 +0,0 @@ - - -InspIRCd: CullItem Class Reference - - - -
Main Page | Namespace List | Class Hierarchy | Alphabetical List | Class List | Directories | File List | Namespace Members | Class Members | File Members
-

CullItem Class Reference

The CullItem class holds a user and their quitmessage, and is used internally by the CullList class to compile a list of users which are to be culled when a long operation (such as a netsplit) has completed. -More... -

-#include <cull_list.h> -

-Collaboration diagram for CullItem:

Collaboration graph
- - - -
[legend]
List of all members. - - - - - - - - - - - - - - - - - - -

Public Member Functions

 CullItem (userrec *u, std::string r)
 Constrcutor.
userrec * GetUser ()
 Returns a pointer to the user.
std::string GetReason ()
 Returns the user's quit reason.

Private Attributes

userrec * user
 Holds a pointer to the user, must be valid and can be a local or remote user.
std::string reason
 Holds the quit reason to use for this user.
-

Detailed Description

-The CullItem class holds a user and their quitmessage, and is used internally by the CullList class to compile a list of users which are to be culled when a long operation (such as a netsplit) has completed. -

- -

-Definition at line 36 of file cull_list.h.

Constructor & Destructor Documentation

-

- - - - -
- - - - - - - - - - - - - - - - - - -
CullItem::CullItem ( userrec *  u,
std::string  r
) 
-
- - - - - -
-   - - -

-Constrcutor. -

-Initializes the CullItem with a user pointer and their quit reason

Parameters:
- - - -
u The user to add
r The quit reason of the added user
-
-
-

Member Function Documentation

-

- - - - -
- - - - - - - - -
std::string CullItem::GetReason (   ) 
-
- - - - - -
-   - - -

-Returns the user's quit reason. -

-

-

- - - - -
- - - - - - - - -
userrec* CullItem::GetUser (   ) 
-
- - - - - -
-   - - -

-Returns a pointer to the user. -

-

-

Member Data Documentation

-

- - - - -
- - - - -
std::string CullItem::reason [private]
-
- - - - - -
-   - - -

-Holds the quit reason to use for this user. -

- -

-Definition at line 45 of file cull_list.h.

-

- - - - -
- - - - -
userrec* CullItem::user [private]
-
- - - - - -
-   - - -

-Holds a pointer to the user, must be valid and can be a local or remote user. -

- -

-Definition at line 42 of file cull_list.h.

-

The documentation for this class was generated from the following file: -
Generated on Mon Dec 19 18:05:21 2005 for InspIRCd by  - -doxygen 1.4.4-20050815
- - -- cgit v1.2.3