some documentation changes (adding comments) and doxygen files)

1 files changed, 58 insertions, 0 deletions

diff --git a/doxygen/man/man3/SysInfo.3 b/doxygen/man/man3/SysInfo.3
new file mode 100644
index 0000000..690bc64
--- /dev/null
+++ b/doxygen/man/man3/SysInfo.3
@@ -0,0 +1,58 @@
+.TH "SysInfo" 3 "Wed Nov 9 2011" "ndgui/NetworkDiscovery" \" -*- nroff -*-
+.ad l
+.nh
+.SH NAME
+SysInfo \- 
+.SH SYNOPSIS
+.br
+.PP
+.PP
+\fC#include <sysinfo.h>\fP
+.SS "Public Member Functions"
+
+.in +1c
+.ti -1c
+.RI "\fBSysInfo\fP ()"
+.br
+.ti -1c
+.RI "\fB~SysInfo\fP ()"
+.br
+.ti -1c
+.RI "const QString \fBgetInfo\fP (const QString &infoName)"
+.br
+.in -1c
+.SH "Constructor & Destructor Documentation"
+.PP 
+.SS "SysInfo::SysInfo ()"A empty constructor. 
+.SS "SysInfo::~SysInfo ()"A empty destructor. 
+.SH "Member Function Documentation"
+.PP 
+.SS "const QString SysInfo::getInfo (const QString &infoName)"This method returns system informations.
+.PP
+This method returns system informations according to the parameter. This method can be called from the \fBJavascriptInterface\fP class with the method \fBJavascriptInterface::getSysInfo(const QString& info)\fP.
+.PP
+\fBParameters:\fP
+.RS 4
+\fIinfoName\fP Is of type QString. Defines which method will be called. Possible values are:
+.IP "\(bu" 2
+mbserial
+.IP "\(bu" 2
+usb
+.PP
+.RE
+.PP
+\fBReturns:\fP
+.RS 4
+QString the output of the called method or 'info_error' if an error occurred (e. g. invalid parameter).
+.RE
+.PP
+\fBSee also:\fP
+.RS 4
+\fBJavascriptInterface::getSysInfo(const QString& info)\fP 
+.RE
+.PP
+
+
+.SH "Author"
+.PP 
+Generated automatically by Doxygen for ndgui/NetworkDiscovery from the source code.