1 files changed, 100 insertions, 0 deletions
diff --git a/doc/api-documentation/man/man3/SWConfig.3 b/doc/api-documentation/man/man3/SWConfig.3
new file mode 100644
index 0000000..ea9bf94
--- /dev/null
+++ b/doc/api-documentation/man/man3/SWConfig.3
@@ -0,0 +1,100 @@
+.TH "SWConfig" 3 "22 Jan 2002" "The Sword Project" \" -*- nroff -*-
+.ad l
+.nh
+.SH NAME
+SWConfig \- The class to read and save settings using a file on disk. 
+.SH SYNOPSIS
+.br
+.PP
+\fC#include <swconfig.h>\fP
+.PP
+.SS "Public Methods"
+
+.in +1c
+.ti -1c
+.RI "\fBSWConfig\fP (const char *ifilename)"
+.br
+.RI "\fIConstructor of SWConfig.\fP"
+.ti -1c
+.RI "virtual \fB~SWConfig\fP ()"
+.br
+.ti -1c
+.RI "virtual void \fBLoad\fP ()"
+.br
+.RI "\fILoad from disk Load the contzent from disk.\fP"
+.ti -1c
+.RI "virtual void \fBSave\fP ()"
+.br
+.RI "\fISave to disk Save the content of this config object to disk.\fP"
+.ti -1c
+.RI "virtual SWConfig & \fBoperator+=\fP (SWConfig &addFrom)"
+.br
+.RI "\fIMerges the values of addFrom.\fP"
+.ti -1c
+.RI "virtual ConfigEntMap & \fBoperator[]\fP (const char *section)"
+.br
+.RI "\fIGet a section This is an easy way to get and store config values.\fP"
+.in -1c
+.SS "Public Attributes"
+
+.in +1c
+.ti -1c
+.RI "string \fBfilename\fP"
+.br
+.RI "\fIThe filename used by this SWConfig object.\fP"
+.ti -1c
+.RI "SectionMap \fBSections\fP"
+.br
+.RI "\fIMap of available sections The map of available sections.\fP"
+.in -1c
+.SS "Private Methods"
+
+.in +1c
+.ti -1c
+.RI "char \fBgetline\fP (FILE *fp, string &line)"
+.br
+.in -1c
+.SH "DETAILED DESCRIPTION"
+.PP 
+The class to read and save settings using a file on disk.
+.PP
+Definition at line 56 of file swconfig.h.
+.SH "CONSTRUCTOR & DESTRUCTOR DOCUMENTATION"
+.PP 
+.SS "SWConfig::SWConfig (const char * ifilename)"
+.PP
+Constructor of SWConfig.
+.PP
+Parameters: 
+.in +1c
+.TP
+\fB\fIifilename\fP\fP
+The file, which should be used for this config. 
+.SH "MEMBER FUNCTION DOCUMENTATION"
+.PP 
+.SS "virtual SWConfig& SWConfig::operator+= (SWConfig & addFrom)\fC [virtual]\fP"
+.PP
+Merges the values of addFrom.
+.PP
+Parameters: 
+.in +1c
+.TP
+\fB\fIThe\fP\fP
+config which values should be merged to this config object. Already existing values will be overwritten. 
+.SS "virtual ConfigEntMap& SWConfig::operator[] (const char * section)\fC [virtual]\fP"
+.PP
+Get a section This is an easy way to get and store config values.
+.PP
+The following will work:
+.br
+
+.PP
+.nf
+ SWConfig config('/home/user/.setttings');
+ config['Colors']['Background'] = 'red';
+.fi
+ 
+
+.SH "AUTHOR"
+.PP 
+Generated automatically by Doxygen for The Sword Project from the source code.
+\ No newline at end of file