diff options
Diffstat (limited to 'docs/man/man3/BoolSet.3')
| -rw-r--r-- | docs/man/man3/BoolSet.3 | 30 |
1 files changed, 22 insertions, 8 deletions
diff --git a/docs/man/man3/BoolSet.3 b/docs/man/man3/BoolSet.3 index 5089a03bf..56bb4b095 100644 --- a/docs/man/man3/BoolSet.3 +++ b/docs/man/man3/BoolSet.3 @@ -1,4 +1,4 @@ -.TH "BoolSet" 3 "30 May 2005" "InspIRCd" \" -*- nroff -*- +.TH "BoolSet" 3 "27 Nov 2005" "Version 1.0Betareleases" "InspIRCd" \" -*- nroff -*- .ad l .nh .SH NAME @@ -65,22 +65,26 @@ BoolSet \- BoolSet is a utility class designed to hold eight bools in a bitmask. .PP BoolSet is a utility class designed to hold eight bools in a bitmask. -Use \fBBoolSet::Set\fP and \fBBoolSet::Get\fP to set and get bools in the bitmask, and Unset and Invert for special operations upon them. +Use \fBBoolSet::Set\fP and \fBBoolSet::Get\fP to set and get bools in the bitmask, and Unset and Invert for special operations upon them. .PP -Definition at line 98 of file base.h. +Definition at line 95 of file base.h. .SH "Constructor & Destructor Documentation" .PP .SS "BoolSet::BoolSet ()" .PP The default constructor initializes the BoolSet to all values unset. +.PP .SS "BoolSet::BoolSet (char bitmask)" .PP This constructor copies the default bitmask from a char. +.PP .SH "Member Function Documentation" .PP .SS "bool BoolSet::Get (int number)" .PP -The Get method returns the value of one bool in the set. \fBParameters:\fP +The Get method returns the value of one bool in the set. +.PP +\fBParameters:\fP .RS 4 \fInumber\fP The number of the item to retrieve. This must be between 0 and 7. .RE @@ -93,7 +97,9 @@ True if the item is set, false if it is unset. .SS "void BoolSet::Invert (int number)" .PP -The Unset method inverts (flips) one value in the set. \fBParameters:\fP +The Unset method inverts (flips) one value in the set. +.PP +\fBParameters:\fP .RS 4 \fInumber\fP The number of the item to invert. This must be between 0 and 7. .RE @@ -102,18 +108,24 @@ The Unset method inverts (flips) one value in the set. \fBParameters:\fP .SS "\fBBoolSet\fP BoolSet::operator & (\fBBoolSet\fP other)" .PP AND two BoolSets together. +.PP .SS "bool BoolSet::operator= (\fBBoolSet\fP other)" .PP Assign one BoolSet to another. +.PP .SS "bool BoolSet::operator== (\fBBoolSet\fP other)" .PP Compare two BoolSets. +.PP .SS "\fBBoolSet\fP BoolSet::operator| (\fBBoolSet\fP other)" .PP OR two BoolSets together. +.PP .SS "void BoolSet::Set (int number)" .PP -The Set method sets one bool in the set. \fBParameters:\fP +The Set method sets one bool in the set. +.PP +\fBParameters:\fP .RS 4 \fInumber\fP The number of the item to set. This must be between 0 and 7. .RE @@ -121,7 +133,9 @@ The Set method sets one bool in the set. \fBParameters:\fP .SS "void BoolSet::Unset (int number)" .PP -The Unset method unsets one value in the set. \fBParameters:\fP +The Unset method unsets one value in the set. +.PP +\fBParameters:\fP .RS 4 \fInumber\fP The number of the item to set. This must be between 0 and 7. .RE @@ -131,7 +145,7 @@ The Unset method unsets one value in the set. \fBParameters:\fP .PP .SS "char \fBBoolSet::bits\fP\fC [private]\fP" .PP -Definition at line 100 of file base.h. +Definition at line 97 of file base.h. .SH "Author" .PP |