summaryrefslogtreecommitdiff
path: root/doc/api-documentation/man/man3/swcom.3
diff options
context:
space:
mode:
Diffstat (limited to 'doc/api-documentation/man/man3/swcom.3')
-rw-r--r--doc/api-documentation/man/man3/swcom.368
1 files changed, 0 insertions, 68 deletions
diff --git a/doc/api-documentation/man/man3/swcom.3 b/doc/api-documentation/man/man3/swcom.3
deleted file mode 100644
index aa3a762..0000000
--- a/doc/api-documentation/man/man3/swcom.3
+++ /dev/null
@@ -1,68 +0,0 @@
-.TH "SWCom" 3 "5 Oct 2001" "The Sword Project" \" -*- nroff -*-
-.ad l
-.nh
-.SH NAME
-SWCom \- The basis for all commentary modules.
-.SH SYNOPSIS
-.br
-.PP
-\fC#include <swcom.h>\fR
-.PP
-Inherits \fBSWModule\fR.
-.PP
-Inherited by HREFCom, RawCom, RawFiles, and zCom.
-.PP
-.SS Public Methods
-
-.in +1c
-.ti -1c
-.RI "\fBSWCom\fR (const char *imodname=0, const char *imoddesc=0, \fBSWDisplay\fR *idisp=0, bool unicode=false)"
-.br
-.RI "\fIInitializes data for instance of SWCom.\fR"
-.ti -1c
-.RI "virtual \fB~SWCom\fR ()"
-.br
-.ti -1c
-.RI "virtual \fBSWKey\fR* \fBCreateKey\fR ()"
-.br
-.RI "\fIAllocates a key of specific type for module.\fR"
-.in -1c
-.SH DETAILED DESCRIPTION
-.PP
-The basis for all commentary modules.
-.PP
-Definition at line 33 of file swcom.h.
-.SH CONSTRUCTOR & DESTRUCTOR DOCUMENTATION
-.PP
-.SS SWCom::SWCom (const char * imodname = 0, const char * imoddesc = 0, \fBSWDisplay\fR * idisp = 0, bool unicode = false)
-.PP
-Initializes data for instance of SWCom.
-.PP
-\fBParameters: \fR
-.in +1c
-.TP
-\fB\fIimodname\fR\fR
-Internal name for module
-.TP
-\fB\fIimoddesc\fR\fR
-Name to display to user for module
-.TP
-\fB\fIidisp\fR\fR
-Display object to use for displaying
-.SH MEMBER FUNCTION DOCUMENTATION
-.PP
-.SS \fBSWKey\fR * SWCom::CreateKey ()\fC [inline, virtual]\fR
-.PP
-Allocates a key of specific type for module.
-.PP
-\fBReturns: \fR
-.in +1c
-pointer to allocated key
-.PP
-Reimplemented from \fBSWModule\fR.
-.PP
-Definition at line 44 of file swcom.h.
-
-.SH AUTHOR
-.PP
-Generated automatically by Doxygen for The Sword Project from the source code. \ No newline at end of file