From: tho <tho@270642c3-0616-0410-b53a-bc976706d245>
Date: Tue, 19 Feb 2008 11:49:08 +0000 (+0000)
Subject: minor documentation updates
X-Git-Url: http://g0dil.de/git?a=commitdiff_plain;h=29825d5db542bd3a6769101abe40a8ed86409613;p=senf.git

minor documentation updates

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

diff --git a/Examples/UDPClientServer/Mainpage.dox b/Examples/UDPClientServer/Mainpage.dox
index 7555d21..b362404 100644
--- a/Examples/UDPClientServer/Mainpage.dox
+++ b/Examples/UDPClientServer/Mainpage.dox
@@ -88,7 +88,7 @@
 
     \until return 0;
 
-    That's it. We finish of by catching the exception and giving as much detail as possible if an
+    That's it. We finish of by catching the exception and giving as much %detail as possible if an
     exception is caught. The \c prettyName function from the \c Utils library is used, to get a nice,
     printable representation of the dynamic type of the exception instance. It is an interface to
     the g++ demangler. This is necessary since the name member of the C++ \c type_info instance is
diff --git a/Makefile b/Makefile
index dad96af..e628a47 100644
--- a/Makefile
+++ b/Makefile
@@ -17,7 +17,7 @@ clean:
 all_docs all_tests all:
 	$(SCONS) $@
 	
-%/test:
+%/test %/doc:
 	$(SCONS) $@
 
 #----------------------------------------------------------------------
diff --git a/PPI/SocketSink.hh b/PPI/SocketSink.hh
index a0a32fd..00ff17d 100644
--- a/PPI/SocketSink.hh
+++ b/PPI/SocketSink.hh
@@ -69,12 +69,12 @@ namespace senf {
 namespace ppi {
 namespace module {
 
-    /** \brief Output module writing data to a FileHandle using the provided Writer.
+    /** \brief Output %module writing data to a FileHandle using the provided Writer.
         If using the default ConnectedDgramWriter the filehandle must be writable, connected and 
         able to handle complete datagrams.  
         
-        This output module will write data to a FileHandle object using a given \a Writer. This
-        output module is active. This requires the file handle to be able to signal its readiness to
+        This output %module will write data to a FileHandle object using a given \a Writer. This
+        output %module is active. This requires the file handle to be able to signal its readiness to
         accept more data via the Scheduler.
 
         The default \a Writer is senf::ppi::ConnectedDgramWriter which will write out the complete packet to
@@ -87,8 +87,8 @@ namespace module {
           public:
               typedef unspecified Handle;                          // type of handle requested
 
-              SomeWriter();                                          // EITHER default constructible OR
-              SomeWriter(SomeWriter const & other);                    // copy constructible
+              SomeWriter();                                        // EITHER default constructible OR
+              SomeWriter(SomeWriter const & other);                // copy constructible
 
               void operator()(Handle handle, Packet packet);       // insertion function
           };
diff --git a/Utils/Logger/Levels.hh b/Utils/Logger/Levels.hh
index 21d5176..1a10285 100644
--- a/Utils/Logger/Levels.hh
+++ b/Utils/Logger/Levels.hh
@@ -74,27 +74,27 @@ namespace log {
 
     ///\{
     
-    /** \brief Log level VERBOSE
+    /** \brief Log level %VERBOSE
         \see loglevels */
     struct VERBOSE   : public detail::LevelBase { static unsigned const value = 1; };
 
-    /** \brief Log level NOTICE
+    /** \brief Log level %NOTICE
         \see loglevels */
     struct NOTICE    : public detail::LevelBase { static unsigned const value = 2; };
 
-    /** \brief Log level MESSAGE
+    /** \brief Log level %MESSAGE
         \see loglevels */
     struct MESSAGE   : public detail::LevelBase { static unsigned const value = 3; };
 
-    /** \brief Log level IMPORTANT
+    /** \brief Log level %IMPORTANT
         \see loglevels */
     struct IMPORTANT : public detail::LevelBase { static unsigned const value = 4; };
 
-    /** \brief Log level CRITICAL
+    /** \brief Log level %CRITICAL
         \see loglevels */
     struct CRITICAL  : public detail::LevelBase { static unsigned const value = 5; };
 
-    /** \brief Log level FATAL
+    /** \brief Log level %FATAL
         \see loglevels */
     struct FATAL     : public detail::LevelBase { static unsigned const value = 6; };
 
@@ -102,7 +102,7 @@ namespace log {
         \see loglevels */
     struct DISABLED  : public detail::LevelBase { static unsigned const value = 7; };
 
-    /** \brief Inherit log level
+    /** \brief Inherit %log level
         \see loglevels */
     struct NONE      : public detail::LevelBase { static unsigned const value = 0; };