From 69abd59513127fae670ba01e51029273c3612799 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Marc=20W=C3=A4ckerlin?= Date: Fri, 18 Feb 2005 15:49:44 +0000 Subject: [PATCH] complete new arrangement of documentation front page --- mrw/mrw.hpp.in | 121 ++++++++++++++++++++++++++++++++++++------------- 1 file changed, 89 insertions(+), 32 deletions(-) diff --git a/mrw/mrw.hpp.in b/mrw/mrw.hpp.in index 5691e37..716a3e1 100644 --- a/mrw/mrw.hpp.in +++ b/mrw/mrw.hpp.in @@ -1,32 +1,91 @@ /** @mainpage - @section intro Introduction + The official homepage is on: + - http://marc.waeckerlin.org/@PACKAGENAME@/index.html + + All features are listed on the "Modules" page. - @verbinclude README + @section intro Introduction - For details, see the "Modules" page. + 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 log4cxx, + cppunit and boost. + + 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 support Supported Platforms + + 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 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 - @section news News + See the "Related Pages". - New in this release (more information on changes in @ref changes): - @verbinclude NEWS - - @section download Download + - @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 (./configure && make all install): - - 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:
+ rpm -Uvh @PACKAGENAME@-@MAJOR@.@MINOR@.@LEAST@-1.i586.rpm + - http://marc.waeckerlin.org/@PACKAGENAME@/@PACKAGENAME@-devel-@MAJOR@.@MINOR@.@LEAST@-1.i586.rpm + - Installation:
+ rpm -Uvh @PACKAGENAME@-devel-@MAJOR@.@MINOR@.@LEAST@-1.i586.rpm + - 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: + -# tar xzf @PACKAGENAME@-@MAJOR@.@MINOR@.@LEAST@.tar.gz + -# cd @PACKAGENAME@-@MAJOR@.@MINOR@.@LEAST@ + -# ./configure && make all install + - Source RPM Packages: + - http://marc.waeckerlin.org/@PACKAGENAME@/@PACKAGENAME@-@MAJOR@.@MINOR@.@LEAST@-1.src.rpm + - Installation:
+ sudo rpmbuild --rebuild @PACKAGENAME@-@MAJOR@.@MINOR@.@LEAST@-1.src.rpm Download this documentation in PDF: - - http://marc.waeckerlin.org/mrw-c++/mrw-c++-@MAJOR@.@MINOR@.@LEAST@.pdf - - The homepage is on: - - http://marc.waeckerlin.org/mrw-c++/index.html + - http://marc.waeckerlin.org/@PACKAGENAME@/@PACKAGENAME@-@MAJOR@.@MINOR@.@LEAST@.pdf +*/ - @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 @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 "Related Pages". - - - @ref license "License Information (LGPL)" - - @ref install "Compilation and Installation Information" - - @ref news "Breaking News" - - @ref changes "Change Log" */ /** @page license License