complete new arrangement of documentation front page
This commit is contained in:
117
mrw/mrw.hpp.in
117
mrw/mrw.hpp.in
@@ -1,32 +1,91 @@
|
||||
/** @mainpage
|
||||
|
||||
The official homepage is on:
|
||||
- http://marc.waeckerlin.org/@PACKAGENAME@/index.html
|
||||
|
||||
All features are listed on the <a
|
||||
href="modules.html">"Modules"</a> page.
|
||||
|
||||
@section intro Introduction
|
||||
|
||||
@verbinclude README
|
||||
Featureful C++ Library containing a lot of needful
|
||||
things. Everything, I often need, but it's missing in C++ standard
|
||||
libraries and other common 3rd party libraries, such as <a href="">log4cxx</a>,
|
||||
cppunit and boost.
|
||||
|
||||
For details, see the <a href="modules.html">"Modules"</a> page.
|
||||
I have paid attention to define simple and a nice to use
|
||||
interfaces. The library makes use of object orientation, operator
|
||||
overload and templates, where it makes sense. The library passes
|
||||
several module tests before each delivery. It is therefore stable
|
||||
and tested.
|
||||
|
||||
@section news News
|
||||
@section support Supported Platforms
|
||||
|
||||
New in this release (more information on changes in @ref changes):
|
||||
@verbinclude NEWS
|
||||
The library is generic UNIX, but should also work on Windows. It
|
||||
is sporadically tested on Windows in Cygwin. Stack trace works on
|
||||
Linux only, it could theoretically work on Sun Solaris too, but
|
||||
this is untested. Stack trace without symbol resolution, just
|
||||
getting the raw addresses, only depends on GNU gcc and should work
|
||||
on all platforms. Feedback is welcome!
|
||||
|
||||
@section download Download
|
||||
@section features Missing a Feature, Found a Bug?
|
||||
|
||||
You are missing a feature, or an implementation is too incomplete
|
||||
for the purpose you need it? Or you even found a bug? Just ask me
|
||||
and I'll try to help you! My email address is in the file AUTHORS
|
||||
and on my website: http://marc.waeckerlin.org
|
||||
|
||||
@section moreinfo Additional Information
|
||||
|
||||
See the <a href="pages.html">"Related Pages"</a>.
|
||||
|
||||
- @ref readme "The Readme, a Short Overview"
|
||||
- @ref download "Download, Dependencies and Simple Installation"
|
||||
- @ref usage "Usage of the Library: Include and Link"
|
||||
- @ref threads "Thread Safety"
|
||||
- @ref libversion "Library Versioning"
|
||||
- @ref license "License Information (LGPL)"
|
||||
- @ref install "Detailed Compilation and Installation Information"
|
||||
- @ref news "Breaking News, What's New?"
|
||||
- @ref changes "Change Log"
|
||||
*/
|
||||
|
||||
/** @page download Download, Detailed und Simple Installation
|
||||
|
||||
Download this version from here:
|
||||
- Source TAR-Ball (<code>./configure && make all install</code>):
|
||||
- http://marc.waeckerlin.org/mrw-c++/mrw-c++-@MAJOR@.@MINOR@.@LEAST@.tar.gz
|
||||
- RPM Packages (built on i586/SuSE):
|
||||
- http://marc.waeckerlin.org/mrw-c++/mrw-c++-@MAJOR@.@MINOR@.@LEAST@-1.i586.rpm
|
||||
- http://marc.waeckerlin.org/mrw-c++/mrw-c++-devel-@MAJOR@.@MINOR@.@LEAST@-1.i586.rpm
|
||||
- Requirements:
|
||||
- No special requirements for the binary package!
|
||||
- Binary
|
||||
- Binary RPM Packages (built on i586/SuSE):
|
||||
- http://marc.waeckerlin.org/@PACKAGENAME@/@PACKAGENAME@-@MAJOR@.@MINOR@.@LEAST@-1.i586.rpm
|
||||
- Installation:<br>
|
||||
<code>rpm -Uvh @PACKAGENAME@-@MAJOR@.@MINOR@.@LEAST@-1.i586.rpm</code>
|
||||
- http://marc.waeckerlin.org/@PACKAGENAME@/@PACKAGENAME@-devel-@MAJOR@.@MINOR@.@LEAST@-1.i586.rpm
|
||||
- Installation:<br>
|
||||
<code>rpm -Uvh @PACKAGENAME@-devel-@MAJOR@.@MINOR@.@LEAST@-1.i586.rpm</code>
|
||||
- Source
|
||||
- Requirements to build from source:
|
||||
- cppunit: http://cppunit.sf.net
|
||||
- log4cxx: http://logging.apache.org/log4cxx
|
||||
- doxygen: http://doxygen.org
|
||||
- graphviz: http://www.research.att.com/sw/tools/graphviz
|
||||
- GNU g++, GNU make, GNU autotools: http://gnu.org
|
||||
- Source TAR-Ball:
|
||||
- http://marc.waeckerlin.org/@PACKAGENAME@/@PACKAGENAME@-@MAJOR@.@MINOR@.@LEAST@.tar.gz
|
||||
- Installation:
|
||||
-# <code>tar xzf @PACKAGENAME@-@MAJOR@.@MINOR@.@LEAST@.tar.gz</code>
|
||||
-# <code>cd @PACKAGENAME@-@MAJOR@.@MINOR@.@LEAST@</code>
|
||||
-# <code>./configure && make all install</code>
|
||||
- Source RPM Packages:
|
||||
- http://marc.waeckerlin.org/@PACKAGENAME@/@PACKAGENAME@-@MAJOR@.@MINOR@.@LEAST@-1.src.rpm
|
||||
- Installation:<br>
|
||||
<code>sudo rpmbuild --rebuild @PACKAGENAME@-@MAJOR@.@MINOR@.@LEAST@-1.src.rpm</code>
|
||||
|
||||
Download this documentation in PDF:
|
||||
- http://marc.waeckerlin.org/mrw-c++/mrw-c++-@MAJOR@.@MINOR@.@LEAST@.pdf
|
||||
- http://marc.waeckerlin.org/@PACKAGENAME@/@PACKAGENAME@-@MAJOR@.@MINOR@.@LEAST@.pdf
|
||||
*/
|
||||
|
||||
The homepage is on:
|
||||
- http://marc.waeckerlin.org/mrw-c++/index.html
|
||||
|
||||
@section usage Usage of the Library
|
||||
/** @page usage Usage of the Library: Include and Link
|
||||
|
||||
Include the headers you need with prefix @c mrw, e.g.:
|
||||
|
||||
@@ -34,8 +93,13 @@
|
||||
#include <mrw/stacktrace.hpp>
|
||||
@endverbatim
|
||||
|
||||
Compile with debug information enabled, thats option @c -g and
|
||||
link to the library with option @c -lmrw, e.g.;
|
||||
All classes are in the mrw namespace.
|
||||
|
||||
if you want the mrw::StackTrace to evaluate file and line numbers,
|
||||
then you need to compile with debug information enabled, thats
|
||||
option @c -g.
|
||||
|
||||
Link to the library with option @c -lmrw, e.g.:
|
||||
|
||||
@verbatim
|
||||
g++ -g -o myprogram myprogram.cpp -lmrw
|
||||
@@ -43,16 +107,18 @@
|
||||
|
||||
For the @ref AutoTools "unexpected handler" you need to link with
|
||||
@c -lmrwexcstderr or @c -lmrwexclog4cxx.
|
||||
*/
|
||||
|
||||
@section threads Thread Safety
|
||||
/** @page threads Thread Safety
|
||||
|
||||
All classes are not thread safe, that means they should either
|
||||
always be accessed from the same thread, or you are responsible
|
||||
for locking. If you need thread safety as a feature, please send
|
||||
me an email and ask me for it (you find the adress in the package
|
||||
me an email and ask me for it (you find the address in the package
|
||||
or on my personal homepage: http://marc.waeckerlin.org).
|
||||
*/
|
||||
|
||||
@section libversion Library Versioning
|
||||
/** @page libversion Library Versioning
|
||||
|
||||
The library and the package have the same version number. This
|
||||
means, if you for example install the package versioned
|
||||
@@ -94,15 +160,6 @@
|
||||
nor with 3.1.4.
|
||||
|
||||
You can see the version of the library by issuing the command @c what.
|
||||
|
||||
@section moreinfo Additional Information
|
||||
|
||||
See the <a href="pages.html">"Related Pages"</a>.
|
||||
|
||||
- @ref license "License Information (LGPL)"
|
||||
- @ref install "Compilation and Installation Information"
|
||||
- @ref news "Breaking News"
|
||||
- @ref changes "Change Log"
|
||||
*/
|
||||
|
||||
/** @page license License
|
||||
|
Reference in New Issue
Block a user