summaryrefslogtreecommitdiff
path: root/doc/api-documentation/man/man3/rwphtml.3
diff options
context:
space:
mode:
Diffstat (limited to 'doc/api-documentation/man/man3/rwphtml.3')
-rw-r--r--doc/api-documentation/man/man3/rwphtml.355
1 files changed, 55 insertions, 0 deletions
diff --git a/doc/api-documentation/man/man3/rwphtml.3 b/doc/api-documentation/man/man3/rwphtml.3
new file mode 100644
index 0000000..a943b94
--- /dev/null
+++ b/doc/api-documentation/man/man3/rwphtml.3
@@ -0,0 +1,55 @@
+.TH "RWPHTML" 3 "5 Oct 2001" "The Sword Project" \" -*- nroff -*-
+.ad l
+.nh
+.SH NAME
+RWPHTML \- this filter converts RWP text to HTML text.
+.SH SYNOPSIS
+.br
+.PP
+\fC#include <rwphtml.h>\fR
+.PP
+Inherits \fBSWFilter\fR.
+.PP
+.SS Public Methods
+
+.in +1c
+.ti -1c
+.RI "\fBRWPHTML\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"
+.in -1c
+.SH DETAILED DESCRIPTION
+.PP
+this filter converts RWP text to HTML text.
+.PP
+Definition at line 31 of file rwphtml.h.
+.SH MEMBER FUNCTION DOCUMENTATION
+.PP
+.SS virtual char RWPHTML::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.
+
+.SH AUTHOR
+.PP
+Generated automatically by Doxygen for The Sword Project from the source code. \ No newline at end of file