overview documentation updates

git-svn-id: https://svn.berlios.de/svnroot/repos/senf/trunk@162 270642c3-0616-0410-b53a-bc976706d245

diff --git a/Doxyfile b/Doxyfile
index a19d334..d928062 100644 (file)
--- a/Doxyfile
+++ b/Doxyfile
@@ -71,7 +71,7 @@ FILE_PATTERNS          = *.dox
 RECURSIVE              = NO
 EXCLUDE                = doc
 EXCLUDE_SYMLINKS       = NO
-EXCLUDE_PATTERNS       = 
+EXCLUDE_PATTERNS       = *~ .#*
 EXAMPLE_PATH           = 
 EXAMPLE_PATTERNS       = 
 EXAMPLE_RECURSIVE      = NO
@@ -171,7 +171,7 @@ ENABLE_PREPROCESSING   = NO
 MACRO_EXPANSION        = YES
 EXPAND_ONLY_PREDEF     = YES
 SEARCH_INCLUDES        = YES
-INCLUDE_PATH           = libs
+INCLUDE_PATH           = 
 INCLUDE_FILE_PATTERNS  = 
 PREDEFINED             = DOXYGEN
 EXPAND_AS_DEFINED      = DefineCommand

diff --git a/Mainpage.dox b/Mainpage.dox
index cd24aad..216699d 100644 (file)
--- a/Mainpage.dox
+++ b/Mainpage.dox
@@ -7,9 +7,9 @@
     purpose utilities and will be expedient to use well beyond its
     primary objective.
 
-    \section goals Goals
+    \section Goals
 
-    The main goals where
+    The main goals where (in no particular order)
 
     \li modular framework design
     \li utilizing the power of modern C++
@@ -17,6 +17,61 @@
     \li extensible design    
     \li concise interface
 
+    \section Components
+
+    The framework is made up of several modular components. When using
+    the library, it is possible to selectively choose to use only a
+    subset of the implemented modules. The modules are
+    
+    \subsection libSocket libSocket: C++ abstraction of the BSD socket API
+
+    This library provides a high performance and object oriented
+    abstraction of the standard socket API. It utilizes a flexible and
+    extensible policy based design. The library provides predefined
+    types for the important socket types (UDP and TCP sockets etc)
+    including raw and packet sockets. \n
+
+    \see <a href="../../Socket/doc/html/index.html">libSocket API
+    reference</a>
+
+    \subsection libPackets libPackets: Network packet manipulation
+
+    This libarary provides a very flexible infrastructure to
+    parse, create and otherwise manipulate packetized network
+    data. Included is a library of several protocol parsers covering
+    the basic IPv4 and IPv6 network protocols down to the Ethernet
+    layer.
+
+    \see <a href="../../Packets/doc/html/index.html">libPackets API
+    reference</a>
+
+    \subsection libScheduler libScheduler: Asynchronous event handling
+
+    The scheduler library provides an object oriented interface to the
+    standard UNIX \c select type event dispatcher. It is based on the
+    high performance \c epoll system call. It provides support for
+    read/write events as well as simple timer based events.
+
+    \see <a href="../../Scheduler/doc/html/index.html">libScheduler API
+    reference</a>
+
+    \subsection libUtils libUtils: Collection of arbitrary utilities
+
+    This library is used be most all of the other modules for
+    miscellaneous tools and utilities. We have
+
+    \li Simple functions to manage daemon processes
+    \li Standard exception classes 
+    \li satcom::lib::intrusive_refcount to simplify the implementation
+       of classes usable with boost::intrusive_ptr
+    \li boost::bind extensions
+    \li An interface to the \c g++ demangler integrated with type_info 
+    \li Typedefs and rudimentary methods to simplify handling
+       high-resolution time values
+
+    \see <a href="../../Utils/doc/html/index.html">libUtils API
+    reference</a>
+
     \section code Coding practices
 
     The library heavily depends on the features of modern C++. As

diff --git a/doclib/Doxyfile.global b/doclib/Doxyfile.global
index eb8488a..f0453ea 100644 (file)
--- a/doclib/Doxyfile.global
+++ b/doclib/Doxyfile.global
@@ -83,7 +83,7 @@ FILE_PATTERNS          = *.c *.cc *.cci *.ct *.cti *.h *.hh *.ih *.mmc *.dox
 RECURSIVE              = NO
 EXCLUDE                = doc
 EXCLUDE_SYMLINKS       = NO
-EXCLUDE_PATTERNS       = *.test.cc
+EXCLUDE_PATTERNS       = *.test.cc *~ .#*
 EXAMPLE_PATH           = 
 EXAMPLE_PATTERNS       = *
 EXAMPLE_RECURSIVE      = NO
@@ -183,7 +183,7 @@ ENABLE_PREPROCESSING   = YES
 MACRO_EXPANSION        = YES
 EXPAND_ONLY_PREDEF     = YES
 SEARCH_INCLUDES        = YES
-INCLUDE_PATH           = libs
+INCLUDE_PATH           = 
 INCLUDE_FILE_PATTERNS  = 
 PREDEFINED             = DOXYGEN
 EXPAND_AS_DEFINED      = DefineCommand

diff --git a/doclib/doxy-header-overview.html b/doclib/doxy-header-overview.html
index 208a635..54a5236 100644 (file)
--- a/doclib/doxy-header-overview.html
+++ b/doclib/doxy-header-overview.html
@@ -20,9 +20,10 @@ div.tabs ul li.$projectname a { background-color: #EDE497; }
     <ul>
       <li class="Overview"><a href="../../doc/html/index.html"><i>Overview</i></a></li>
       <li><a href="http://senf.berlios.de"><i>SENF @ BerliOS</i></a></li>
+
+      <li class="libSocket"><a href="../../Socket/doc/html/index.html">libSocket</a></li>
       <li class="libPackets"><a href="../../Packets/doc/html/index.html">libPackets</a></li>
       <li class="libScheduler"><a href="../../Scheduler/doc/html/index.html">libScheduler</a></li>
-      <li class="libSocket"><a href="../../Socket/doc/html/index.html">libSocket</a></li>
       <li class="libUtils"><a href="../../Utils/doc/html/index.html">libUtils</a></li>
     </ul>
   </div>

diff --git a/doclib/doxy-header.html b/doclib/doxy-header.html
index 46e7b66..d156d1c 100644 (file)
--- a/doclib/doxy-header.html
+++ b/doclib/doxy-header.html
@@ -20,9 +20,10 @@ div.tabs ul li.$projectname a { background-color: #EDE497; }
     <ul>
       <li class="Overview"><a href="../../../doc/html/index.html"><i>Overview</i></a></li>
       <li><a href="http://senf.berlios.de"><i>SENF @ BerliOS</i></a></li>
+
+      <li class="libSocket"><a href="../../../Socket/doc/html/index.html">libSocket</a></li>
       <li class="libPackets"><a href="../../../Packets/doc/html/index.html">libPackets</a></li>
       <li class="libScheduler"><a href="../../../Scheduler/doc/html/index.html">libScheduler</a></li>
-      <li class="libSocket"><a href="../../../Socket/doc/html/index.html">libSocket</a></li>
       <li class="libUtils"><a href="../../../Utils/doc/html/index.html">libUtils</a></li>
     </ul>
   </div>