diff options
Diffstat (limited to 'doc/api-documentation/man/man3/strkey.3')
-rw-r--r-- | doc/api-documentation/man/man3/strkey.3 | 60 |
1 files changed, 60 insertions, 0 deletions
diff --git a/doc/api-documentation/man/man3/strkey.3 b/doc/api-documentation/man/man3/strkey.3 new file mode 100644 index 0000000..efe9fd8 --- /dev/null +++ b/doc/api-documentation/man/man3/strkey.3 @@ -0,0 +1,60 @@ +.TH "StrKey" 3 "5 Oct 2001" "The Sword Project" \" -*- nroff -*- +.ad l +.nh +.SH NAME +StrKey \- a standard string key class (used for modules that index on single strings (eg. +.SH SYNOPSIS +.br +.PP +\fC#include <strkey.h>\fR +.PP +Inherits \fBSWKey\fR. +.PP +.SS Public Methods + +.in +1c +.ti -1c +.RI "\fBStrKey\fR (const char *ikey=0)" +.br +.RI "\fIinitializes instance of StrKey.\fR" +.ti -1c +.RI "virtual \fB~StrKey\fR ()" +.br +.RI "\fIcleans up instance of StrKey.\fR" +.in -1c +.SS Private Methods + +.in +1c +.ti -1c +.RI "void \fBinit\fR ()" +.br +.in -1c +.SS Static Private Attributes + +.in +1c +.ti -1c +.RI "\fBSWClass\fR \fBclassdef\fR" +.br +.in -1c +.SH DETAILED DESCRIPTION +.PP +a standard string key class (used for modules that index on single strings (eg. +.PP +cities, names, words, etc.) +.PP +Definition at line 35 of file strkey.h. +.SH CONSTRUCTOR & DESTRUCTOR DOCUMENTATION +.PP +.SS StrKey::StrKey (const char * ikey = 0) +.PP +initializes instance of StrKey. +.PP +\fBParameters: \fR +.in +1c +.TP +\fB\fIikey\fR\fR +text key (word, city, name, etc.) + +.SH AUTHOR +.PP +Generated automatically by Doxygen for The Sword Project from the source code.
\ No newline at end of file |