From: g0dil <g0dil@270642c3-0616-0410-b53a-bc976706d245>
Date: Tue, 13 Nov 2007 15:28:10 +0000 (+0000)
Subject: Small documentation updates
X-Git-Url: http://g0dil.de/git?a=commitdiff_plain;h=70218c843c757e3ed781d9576d7a429673a6d6e2;p=senf.git

Small documentation updates

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

diff --git a/Packets/PacketParser.hh b/Packets/PacketParser.hh
index 010780e..ca57409 100644
--- a/Packets/PacketParser.hh
+++ b/Packets/PacketParser.hh
@@ -181,10 +181,8 @@ namespace senf {
         Both kinds of parser need to derive from PacketParserBase and implement several required
         members. Which members to implement depends on the parsers flavor. There are two ways how to
         do this.
-        \li If the parser just consists of a simple sequence of consecutive fields (sub-parsers),
-            the \ref SENF_PACKET_PARSER_DEFINE_FIELDS and \ref
-            SENF_PACKET_PARSER_DEFINE_FIXED_FIELDS macros provide a simple and convenient way to
-            define the packet
+        \li If the parser just consists of sequence of consecutive fields (sub-parsers), the \ref
+            packetparsermacros provide a simple yet flexible way to define a packet parser.
         \li In more complex cases, you need to implement the necessary members manually.
 
         This documentation is about the manual implementation. You should nevertheless read through
diff --git a/Scheduler/ClockService.cc b/Scheduler/ClockService.cc
index e481c14..21a34b4 100644
--- a/Scheduler/ClockService.cc
+++ b/Scheduler/ClockService.cc
@@ -49,6 +49,7 @@ struct senf::ClockService::Impl
     void block();
     void unblock();
 
+    /// Internal: temporarily block signals (RAII idiom)
     struct Blocker {
         Blocker(Impl * i) : impl(i) { impl->block(); }
         ~Blocker() { impl->unblock(); }
diff --git a/Scheduler/ClockService.hh b/Scheduler/ClockService.hh
index d17eaf9..bb9bdd1 100644
--- a/Scheduler/ClockService.hh
+++ b/Scheduler/ClockService.hh
@@ -160,6 +160,7 @@ namespace senf {
         boost::posix_time::ptime heartbeat_;
 
         // I don't want this header to depend on the legacy C headers.
+        /// Internal: ClockService private data (PIMPL idiom)
         struct Impl;
         boost::scoped_ptr<Impl> impl_;
 
diff --git a/Scheduler/Scheduler.hh b/Scheduler/Scheduler.hh
index 94918af..421325d 100644
--- a/Scheduler/Scheduler.hh
+++ b/Scheduler/Scheduler.hh
@@ -281,6 +281,7 @@ namespace senf {
         void unregisterSignal(unsigned signal);
                                         ///< Remove signal handler for \a signal
 
+        /// The signal number passed to registerSignal or unregisterSignal is invalid
         struct InvalidSignalNumberException : public std::exception
         { virtual char const * what() const throw() 
                 { return "senf::Scheduler::InvalidSignalNumberException"; } };