1 files changed, 100 insertions, 0 deletions
diff --git a/doc/api-documentation/man/man3/SWLD.3 b/doc/api-documentation/man/man3/SWLD.3
new file mode 100644
index 0000000..4f1a273
--- /dev/null
+++ b/doc/api-documentation/man/man3/SWLD.3
@@ -0,0 +1,100 @@
+.TH "SWLD" 3 "22 Jan 2002" "The Sword Project" \" -*- nroff -*-
+.ad l
+.nh
+.SH NAME
+SWLD \- the basis for all types of Lexicon and Dictionary modules (hence the 'LD'). 
+.SH SYNOPSIS
+.br
+.PP
+\fC#include <swld.h>\fP
+.PP
+Inherits \fBSWModule\fP.
+.PP
+Inherited by RawLD, RawLD4, and zLD.
+.PP
+.SS "Public Methods"
+
+.in +1c
+.ti -1c
+.RI "\fBSWLD\fP (const char *imodname=0, const char *imoddesc=0, \fBSWDisplay\fP *idisp=0, SWTextEncoding encoding=ENC_UNKNOWN, SWTextDirection dir=DIRECTION_LTR, SWTextMarkup markup=FMT_UNKNOWN, const char *ilang=0)"
+.br
+.RI "\fIInitializes data for instance of SWLD.\fP"
+.ti -1c
+.RI "virtual \fB~SWLD\fP ()"
+.br
+.ti -1c
+.RI "virtual \fBSWKey\fP * \fBCreateKey\fP ()"
+.br
+.RI "\fIAllocates a key of specific type for module The different reimplementatiosn of \fBSWModule\fP (e.g.\fP"
+.ti -1c
+.RI "virtual const char * \fBKeyText\fP (const char *ikeytext)"
+.br
+.RI "\fISets/gets module KeyText, getting from saved text if key is persistent.\fP"
+.in -1c
+.SS "Protected Attributes"
+
+.in +1c
+.ti -1c
+.RI "char * \fBentkeytxt\fP"
+.br
+.in -1c
+.SH "DETAILED DESCRIPTION"
+.PP 
+the basis for all types of Lexicon and Dictionary modules (hence the 'LD').
+.PP
+Definition at line 34 of file swld.h.
+.SH "CONSTRUCTOR & DESTRUCTOR DOCUMENTATION"
+.PP 
+.SS "SWLD::SWLD (const char * imodname = 0, const char * imoddesc = 0, \fBSWDisplay\fP * idisp = 0, SWTextEncoding encoding = ENC_UNKNOWN, SWTextDirection dir = DIRECTION_LTR, SWTextMarkup markup = FMT_UNKNOWN, const char * ilang = 0)"
+.PP
+Initializes data for instance of SWLD.
+.PP
+Parameters: 
+.in +1c
+.TP
+\fB\fIimodname\fP\fP
+Internal name for module 
+.TP
+\fB\fIimoddesc\fP\fP
+Name to display to user for module 
+.TP
+\fB\fIidisp\fP\fP
+Display object to use for displaying 
+.SH "MEMBER FUNCTION DOCUMENTATION"
+.PP 
+.SS "virtual \fBSWKey\fP* SWLD::CreateKey ()\fC [inline, virtual]\fP"
+.PP
+Allocates a key of specific type for module The different reimplementatiosn of \fBSWModule\fP (e.g.
+.PP
+\fBSWText\fP) support \fBSWKey\fP implementations, which support special. This functions returns a \fBSWKey\fP object which works with the current implementation of \fBSWModule\fP. For example for the \fBSWText\fP class it returns a \fBVerseKey\fP object. 
+.PP
+\fBSee also: \fP
+.in +1c
+\fBVerseKey\fP, \fBListKey\fP, \fBSWText\fP, SWLD, \fBSWCom\fP 
+.PP
+\fBReturns: \fP
+.in +1c
+pointer to allocated key 
+.PP
+Reimplemented from \fBSWModule\fP.
+.PP
+Definition at line 47 of file swld.h.
+.SS "virtual const char* SWLD::KeyText (const char * ikeytext)\fC [virtual]\fP"
+.PP
+Sets/gets module KeyText, getting from saved text if key is persistent.
+.PP
+Parameters: 
+.in +1c
+.TP
+\fB\fIikeytext\fP\fP
+value which to set keytext; [0] - only get 
+.PP
+\fBReturns: \fP
+.in +1c
+pointer to keytext 
+.PP
+Reimplemented from \fBSWModule\fP.
+
+.SH "AUTHOR"
+.PP 
+Generated automatically by Doxygen for The Sword Project from the source code.
+\ No newline at end of file