diff options
Diffstat (limited to 'doc/api-documentation/man/man3/thmlplain.3')
-rw-r--r-- | doc/api-documentation/man/man3/thmlplain.3 | 52 |
1 files changed, 52 insertions, 0 deletions
diff --git a/doc/api-documentation/man/man3/thmlplain.3 b/doc/api-documentation/man/man3/thmlplain.3 new file mode 100644 index 0000000..b6e05a7 --- /dev/null +++ b/doc/api-documentation/man/man3/thmlplain.3 @@ -0,0 +1,52 @@ +.TH "ThMLPlain" 3 "5 Oct 2001" "The Sword Project" \" -*- nroff -*- +.ad l +.nh +.SH NAME +ThMLPlain \- this filter converts ThML text to plain text. +.SH SYNOPSIS +.br +.PP +\fC#include <thmlplain.h>\fR +.PP +Inherits \fBSWFilter\fR. +.PP +.SS Public Methods + +.in +1c +.ti -1c +.RI "\fBThMLPlain\fR ()" +.br +.ti -1c +.RI "virtual char \fBProcessText\fR (char *text, int maxlen=-1)" +.br +.RI "\fIThis is the main filter function without the 3rd parameter.\fR" +.in -1c +.SH DETAILED DESCRIPTION +.PP +this filter converts ThML text to plain text. +.PP +Definition at line 30 of file thmlplain.h. +.SH MEMBER FUNCTION DOCUMENTATION +.PP +.SS virtual char ThMLPlain::ProcessText (char * text, int maxlen = -1)\fC [virtual]\fR +.PP +This is the main filter function without the 3rd parameter. +.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 +.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 |