Implemented global cross-reference generation
[senf.git] / Mainpage.dox
index 54d75f8..2ded007 100644 (file)
@@ -30,8 +30,9 @@
 
     \see \ref usage\n
          \ref example\n
-         <a href="http://developer.berlios.de/projects/senf"><b><i>The BerliOS project page</i></b></a>\n
-         <a href="http://openfacts.berlios.de/index-en.phtml?title=SENF+Network+Framework"><b><i>The SENF Wiki at BerliOS</i></b></a>
+         <a href="xref.html">Current status: Cross reference of action points</a>\n
+         <a class="ext" href="http://developer.berlios.de/projects/senf">The BerliOS project page</a>\n
+         <a class="ext" href="http://openfacts.berlios.de/index-en.phtml?title=SENF+Network+Framework">The SENF Wiki at BerliOS</a>
 */
 
 /** \page usage Using the SENF framework
@@ -70,9 +71,6 @@
     POSIX platforms with a BSD Socket API, the library should be
     usable, possibly with some tweaking (except for the Scheduler,
     which relies on \c epoll)
-    
-    \todo
-    \li coding standards and patterns
  */
 
 /** \page build Building the framework
 
     \li Simple functions to manage daemon processes
     \li Standard exception classes 
-    \li satcom::lib::intrusive_refcount to simplify the implementation
+    \li senf::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 
     environment. Included are a number of templates to help
     bootstrapping a new project or component.
 
-    \see <a href="../../satscons/doc/html/index.html">SENFSCons
+    \see <a href="../../senfscons/doc/html/index.html">SENFSCons
     reference</a>
  */
 
 
     The default editor (probably VI) will be started with the current
     value of the svn:externals property (which will probably be
-    empty). Now add all the modules you want plus \c satscons and
+    empty). Now add all the modules you want plus \c senfscons and
     possibly \c doclib (if you want to build the documentation). You
     will almost certainly neeed the \c Utils module, since all other
     modules depend on it.
     module, the file will look like
 
       <pre class="fragment">
-        satscons http://svn.berlios.de/svnroot/repos/senf/trunk/satscons
+        senfscons http://svn.berlios.de/svnroot/repos/senf/trunk/senfscons
         Utils http://svn.berlios.de/svnroot/repos/senf/trunk/Utils
         Scheduler http://svn.berlios.de/svnroot/repos/senf/trunk/Scheduler
         Socket http://svn.berlios.de/svnroot/repos/senf/trunk/Socket</pre>
     \section new_conf Configuring SENFSCons
 
     To set up the build environment, copy the
-    <tt>satscons/SConstruct.template</tt> to <tt>Satscons</tt> in the
+    <tt>senfscons/SConstruct.template</tt> to <tt>Satscons</tt> in the
     project root. The default setup of this file is to build all
     subdirectories (using the \c SConscript files of the
     subdirectories). You can add additonal global targets and
 
     If you want to use a non-default compiler or the boost library is
     not installed in the system directories, you will have to copy
-    <tt>satscons/SConfig.template</tt> to <tt>SConfig</tt> in the
+    <tt>senfscons/SConfig.template</tt> to <tt>SConfig</tt> in the
     project root and edit it there. You should \e never add \c SConfig
     to the repository since it should only contain local settings
     necessary for building on your local system. You should therefore
     <pre class="fragment">
       $ scons -u [target]</pre>
 
-    \see <a href="../../satscons/doc/html/index.html"><b>SENFSCons reference</b></a> \n
-         <a href="http://www.scons.org/documentation.php"><b><i>SCons documentation</i></b></a> \n
-         <a href="http://svnbook.red-bean.com"><b><i>Subversion online book</i></b></a> \n
-         <a href="http://subversion.tigris.org"><b><i>Subversion Homepage</i></b></a>
+    \see <a href="../../senfscons/doc/html/index.html">SENFSCons reference</a> \n
+         <a class="ext" href="http://www.scons.org/documentation.php">SCons documentation</a> \n
+         <a class="ext" href="http://svnbook.red-bean.com">Subversion online book</a> \n
+         <a class="ext" href="http://subversion.tigris.org">Subversion Homepage</a>
  */
 
 /** \page overview Introduction to the framework
     When building a network Application with SENF, you will use
     several modules:
     
-    \li Use the <a href="../../Socket/doc/html/index.html"><b>Socket
-       library</b></a> for network communication needs. This library
+    \li Use the <a href="../../Socket/doc/html/index.html">Socket
+       library</a> for network communication needs. This library
        includes support for raw and packet sockets to allow low level
        network access.
     \li Use the <a
-       href="../../Scheduler/doc/html/index.html"><b>Scheduler
-       library</b></a> to coordinate the asynchronous event
+       href="../../Scheduler/doc/html/index.html">Scheduler
+       library</a> to coordinate the asynchronous event
        processing. This drastically reduces the number of threads
        needed in your application and will greatly enhance the overall
        responsiveness.
     \li To interpret low level network packets, use the <a
-       href="../../Packets/doc/html/index.html"><b>Packets
-       library</b></a>. This library will provide efficient and 
+       href="../../Packets/doc/html/index.html">Packets
+       library</a>. This library will provide efficient and 
        convenient access to all protocol fields. It supports parsing as
        well as modifying and creating packets. It has default support
        for the most important TCP protocols and is highly extensible
        with new protocols.
-    \li Go over the <a href="../../Utils/doc/html/index.html"><b>Utils
-       library</b></a>. It contains small helpers to
+    \li Go over the <a href="../../Utils/doc/html/index.html">Utils
+       library</a>. It contains small helpers to
        simplify tasks like daemonization, exception handling,
         debugging and so on.