1 files changed, 147 insertions, 0 deletions
diff --git a/doc/api-documentation/man/man3/gbfstrongs.3 b/doc/api-documentation/man/man3/gbfstrongs.3
new file mode 100644
index 0000000..24cc79e
--- /dev/null
+++ b/doc/api-documentation/man/man3/gbfstrongs.3
@@ -0,0 +1,147 @@
+.TH "GBFStrongs" 3 "5 Oct 2001" "The Sword Project" \" -*- nroff -*-
+.ad l
+.nh
+.SH NAME
+GBFStrongs \- This Filter shows/hides strong's numbers in a GBF text. 
+.SH SYNOPSIS
+.br
+.PP
+\fC#include <gbfstrongs.h>\fR
+.PP
+Inherits \fBSWFilter\fR.
+.PP
+.SS Public Methods
+
+.in +1c
+.ti -1c
+.RI "\fBGBFStrongs\fR ()"
+.br
+.ti -1c
+.RI "virtual \fB~GBFStrongs\fR ()"
+.br
+.ti -1c
+.RI "virtual char \fBProcessText\fR (char *text, int maxlen, const \fBSWKey\fR *key)"
+.br
+.RI "\fIThis is the main filter function.\fR"
+.ti -1c
+.RI "virtual const char* \fBgetOptionName\fR ()"
+.br
+.RI "\fIgets the name of the option of this filter.\fR"
+.ti -1c
+.RI "virtual const char* \fBgetOptionTip\fR ()"
+.br
+.RI "\fIgets a short explanation of the option of this filter; it could be presented to the user in frontend programs.\fR"
+.ti -1c
+.RI "virtual void \fBsetOptionValue\fR (const char *ival)"
+.br
+.RI "\fIsets the value of the option of this filter, e.g maybe a strong's filter mioght be set to "on" / "off" - that would mean to show or not to show the strongs in the text, see also \fBgetOptionValues\fR.\fR"
+.ti -1c
+.RI "virtual const char* \fBgetOptionValue\fR ()"
+.br
+.ti -1c
+.RI "virtual OptionsList \fBgetOptionValues\fR ()"
+.br
+.RI "\fIreturns a list of the possible option values might be.\fR"
+.in -1c
+.SS Private Attributes
+
+.in +1c
+.ti -1c
+.RI "bool \fBoption\fR"
+.br
+.ti -1c
+.RI "OptionsList \fBoptions\fR"
+.br
+.in -1c
+.SS Static Private Attributes
+
+.in +1c
+.ti -1c
+.RI "const char \fBon\fR []"
+.br
+.ti -1c
+.RI "const char \fBoff\fR []"
+.br
+.ti -1c
+.RI "const char \fBoptName\fR []"
+.br
+.ti -1c
+.RI "const char \fBoptTip\fR []"
+.br
+.in -1c
+.SH DETAILED DESCRIPTION
+.PP 
+This Filter shows/hides strong's numbers in a GBF text.
+.PP
+Definition at line 30 of file gbfstrongs.h.
+.SH MEMBER FUNCTION DOCUMENTATION
+.PP 
+.SS virtual char GBFStrongs::ProcessText (char * text, int maxlen, const \fBSWKey\fR * key)\fC [virtual]\fR
+.PP
+This is the main filter function.
+.PP
+\fBParameters: \fR
+.in +1c
+.TP
+\fB\fItext\fR\fR
+the text to be filtered/converted 
+.TP
+\fB\fImaxlen\fR\fR
+maximal length of text to be processed 
+.TP
+\fB\fIkey\fR\fR
+sorry I don't know 
+.PP
+\fBReturns: \fR
+.in +1c
+0 
+.PP
+Reimplemented from \fBSWFilter\fR.
+.SS const char * GBFStrongs::getOptionName ()\fC [inline, virtual]\fR
+.PP
+gets the name of the option of this filter.
+.PP
+\fBReturns: \fR
+.in +1c
+option name 
+.PP
+Reimplemented from \fBSWFilter\fR.
+.PP
+Definition at line 42 of file gbfstrongs.h.
+.SS const char * GBFStrongs::getOptionTip ()\fC [inline, virtual]\fR
+.PP
+gets a short explanation of the option of this filter; it could be presented to the user in frontend programs.
+.PP
+\fBReturns: \fR
+.in +1c
+option tip/explanation 
+.PP
+Reimplemented from \fBSWFilter\fR.
+.PP
+Definition at line 46 of file gbfstrongs.h.
+.SS OptionsList GBFStrongs::getOptionValues ()\fC [inline, virtual]\fR
+.PP
+returns a list of the possible option values might be.
+.PP
+\fBReturns: \fR
+.in +1c
+list of option values 
+.PP
+Reimplemented from \fBSWFilter\fR.
+.PP
+Definition at line 52 of file gbfstrongs.h.
+.SS virtual void GBFStrongs::setOptionValue (const char * ival)\fC [virtual]\fR
+.PP
+sets the value of the option of this filter, e.g maybe a strong's filter mioght be set to "on" / "off" - that would mean to show or not to show the strongs in the text, see also \fBgetOptionValues\fR.
+.PP
+\fBParameters: \fR
+.in +1c
+.TP
+\fB\fIival\fR\fR
+the new option valus 
+.PP
+Reimplemented from \fBSWFilter\fR.
+
+.SH AUTHOR
+.PP 
+Generated automatically by Doxygen for The Sword Project from the source code.
+\ No newline at end of file