Whitespce cleanup: Remove whitespace at end-on-line, remove tabs, wrap

[senf.git] / senf / Packets / PacketRegistry.hh

diff --git a/senf/Packets/PacketRegistry.hh b/senf/Packets/PacketRegistry.hh
index 2311f3e..fe21ab5 100644 (file)
--- a/senf/Packets/PacketRegistry.hh
+++ b/senf/Packets/PacketRegistry.hh
@@ -31,7 +31,7 @@
 #include <boost/utility.hpp> // for boost::noncopyable
 #include <boost/optional.hpp>
 #include <boost/preprocessor/cat.hpp>
-#include "../Utils/Exception.hh"
+#include <senf/Utils/Exception.hh>
 #include "Packet.hh"
 
 #include "PacketRegistry.ih"
@@ -79,6 +79,11 @@ namespace senf {
         this inclusion, you should not put packet registrations into a library but into an object
         file.
 
+        To simplify static registration the SENF_PACKET_REGISTRY_REGISTER macro can be used:
+        \code
+        SENF_PACKET_REGISTRY_REGISTER(SomeTag, SomePacket, key_of_somePacket);
+        \endcode
+
         \ingroup packet_module
      */
     template <class Tag>
@@ -196,6 +201,7 @@ namespace senf {
         This macro will declare an anonymous global variable in such a way, that constructing this
         variable will add a registration to the given packet registry.
 
+        \ingroup packet_module
         \hideinitializer
      */
 #   define SENF_PACKET_REGISTRY_REGISTER( registry, value, type )                                 \
@@ -216,7 +222,7 @@ namespace senf {
         This exception is signaled whenever a throwing lookup operation fails.
      */
     struct PacketTypeNotRegisteredException : public senf::Exception
-    { PacketTypeNotRegisteredException() : senf::Exception("packet type not registered"){} };
+    { PacketTypeNotRegisteredException() : senf::Exception("packet type not registered") {} };
 
 }
 
@@ -229,7 +235,7 @@ namespace senf {
 #include "PacketRegistry.cti"
 #endif
 
-
+\f
 // Local Variables:
 // mode: c++
 // fill-column: 100