Started a glossary implementation (initialized from the socket lib glossary) in Gloss...
[senf.git] / Socket / Mainpage.dox
index 4802f4a..62feb85 100644 (file)
@@ -1,3 +1,25 @@
+// $Id$
+//
+// Copyright (C) 2007 
+// Fraunhofer Institute for Open Communication Systems (FOKUS) 
+// Competence Center NETwork research (NET), St. Augustin, GERMANY 
+//     Stefan Bund <g0dil@berlios.de>
+//
+// This program is free software; you can redistribute it and/or modify
+// it under the terms of the GNU General Public License as published by
+// the Free Software Foundation; either version 2 of the License, or
+// (at your option) any later version.
+//
+// This program is distributed in the hope that it will be useful,
+// but WITHOUT ANY WARRANTY; without even the implied warranty of
+// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+// GNU General Public License for more details.
+//
+// You should have received a copy of the GNU General Public License
+// along with this program; if not, write to the
+// Free Software Foundation, Inc.,
+// 59 Temple Place - Suite 330, Boston, MA  02111-1307, USA.
+
 namespace senf {
 
 /** \mainpage The SENF Socket Library
@@ -16,13 +38,15 @@ namespace senf {
     functions (like reading and writing) and the inheritance hierarchy provides convenient access to
     the multitude of special and protocol dependent options.
 
-    \see \ref structure \n
-         \ref usage \n
-         \ref handle_group \n
-         \ref policy_group \n
-         \ref protocol_group \n
-         \ref extend \n
-         \ref implementation
+    \see 
+        \ref structure \n
+        \ref usage \n
+        \ref handle_group \n
+        \ref policy_group \n
+        \ref protocol_group \n
+        \ref addr_group \n
+        \ref extend \n
+        \ref implementation
  */
 
 /** \page structure Overview of the Socket Library Structure
@@ -219,40 +243,6 @@ namespace senf {
     \see policy_group
  */
 
-/** \page glossary Glossary
-
-    <table class="glossary">
-
-    <tr><td>policy</td> <td>collection of policy classes, one for each policy axis, instantiation of
-    the SocketPolicy template</td></tr>
-
-    <tr><td>policy axis</td> <td>one aspect defined in the socket policy, typedef and member of the
-    SocketPolicy template</td></tr>
-
-    <tr><td>policy class</td> <td>implementation of a single policy axis, class derived from the
-    axis base class</td></tr>
-
-    <tr><td>complete policy</td> <td>socket policy where each axis is specified completely</td></tr>
-
-    <tr><td>incomplete policy</td> <td>socket policy, where at least one axis is not fully
-    specified</td></tr>
-
-    <tr><td>protocol class</td> <td>definition of a protocol as a class, class inheriting from
-    ConcreteSocketProtocol.</td></tr>
-
-    <tr><td>protocol facet</td> <td>a class providing some subset of the protocol interface, class
-    derived from SocketProtocol but not from ConcreteSocketProtocol</td></tr>
-
-    <tr><td>policy interface</td> <td>interface directly provided by
-    ClientSocketHandle/ServerSocketHandle and defined through the policy</td>
-
-    <tr><td>protocol interface</td> <td>interface provided by the protocol class and accessible via
-    the ProtocolClientSocketHandle::protocol()/ProtocolServerSocketHandle::protocol()
-    member</td></tr>
-
-    </table>
- */
-
 /** \page implementation Implementation notes
 
     \section class_diagram Class Diagram