diff options
| author | brain <brain@e03df62e-2008-0410-955e-edbf42e46eb7> | 2005-12-15 11:15:09 +0000 |
|---|---|---|
| committer | brain <brain@e03df62e-2008-0410-955e-edbf42e46eb7> | 2005-12-15 11:15:09 +0000 |
| commit | e0db7b0d2f777361c8194c5820bb2f6e44c55204 (patch) | |
| tree | 77b03ffd8512613c338900f11e0fb5cad135b9be /docs/man/man3/cull_list.h.3 | |
| parent | 8e4d0d74e696a4f2b31ed4abbe243faa444750c0 (diff) | |
Added documentation for CullItem and CullList
git-svn-id: http://svn.inspircd.org/repository/trunk/inspircd@2466 e03df62e-2008-0410-955e-edbf42e46eb7
Diffstat (limited to 'docs/man/man3/cull_list.h.3')
| -rw-r--r-- | docs/man/man3/cull_list.h.3 | 40 |
1 files changed, 40 insertions, 0 deletions
diff --git a/docs/man/man3/cull_list.h.3 b/docs/man/man3/cull_list.h.3 new file mode 100644 index 000000000..b6ded78a3 --- /dev/null +++ b/docs/man/man3/cull_list.h.3 @@ -0,0 +1,40 @@ +.TH "cull_list.h" 3 "15 Dec 2005" "Version 1.0Betareleases" "InspIRCd" \" -*- nroff -*- +.ad l +.nh +.SH NAME +cull_list.h \- +.SH SYNOPSIS +.br +.PP +\fC#include <typeinfo>\fP +.br +\fC#include <iostream>\fP +.br +\fC#include <string>\fP +.br +\fC#include <deque>\fP +.br +\fC#include <sstream>\fP +.br +\fC#include <vector>\fP +.br +\fC#include 'users.h'\fP +.br +\fC#include 'channels.h'\fP +.br + +.SS "Classes" + +.in +1c +.ti -1c +.RI "class \fBCullItem\fP" +.br +.RI "\fIThe CullItem class holds a user and their quitmessage, and is used internally by the \fBCullList\fP class to compile a list of users which are to be culled when a long operation (such as a netsplit) has completed. \fP" +.ti -1c +.RI "class \fBCullList\fP" +.br +.RI "\fIThe CullList class can be used by modules, and is used by the core, to compile large lists of users in preperation to quitting them all at once. \fP" +.in -1c +.SH "Author" +.PP +Generated automatically by Doxygen for InspIRCd from the source code. |