X-Git-Url: http://g0dil.de/git?a=blobdiff_plain;f=PPI%2FModuleManager.hh;h=4559af341c57ef95f74e1c6d0370ac4aaa1fc2b7;hb=ed0e2329281a50f80be8425938c17515fa70661b;hp=843562bb24006c117c816bea8c0043ef66a2808d;hpb=0327b3f303ea2a61d44a30bfaac022874dcf2a0d;p=senf.git

diff --git a/PPI/ModuleManager.hh b/PPI/ModuleManager.hh
index 843562b..4559af3 100644
--- a/PPI/ModuleManager.hh
+++ b/PPI/ModuleManager.hh
@@ -1,8 +1,8 @@
 // $Id$
 //
 // Copyright (C) 2007 
-// Fraunhofer Institut fuer offene Kommunikationssysteme (FOKUS)
-// Kompetenzzentrum fuer Satelitenkommunikation (SatCom)
+// 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
@@ -36,7 +36,10 @@
 namespace senf {
 namespace ppi {
 
-    /** \brief
+    /** \brief Internal: Module management
+
+        Every module is registered with the ModuleManager. The ModuleManager controls module
+        initialization and execution of the network.
       */
     class ModuleManager
     {
@@ -57,25 +60,29 @@ namespace ppi {
         ///@}
         ///////////////////////////////////////////////////////////////////////////
 
-        void registerModule(module::Module & module);
-        void unregisterModule(module::Module & module);
-        
-        void init();
-        void run();
+        void init();                    ///< Called by senf::ppi::init()
+        void run();                     ///< Called by senf::ppi::run()
 
-        bool running() const;
+        bool running() const;           ///< \c true, if the network is running
 
     private:
         ModuleManager();
 
+        void registerModule(module::Module & module);
+        void unregisterModule(module::Module & module);
+        
         typedef std::vector<module::Module *> ModuleRegistry;
 
+#ifndef DOXYGEN
         struct RunGuard;
         friend class RunGuard;
+#endif
 
         ModuleRegistry moduleRegistry_;
         bool running_;
         bool terminate_;
+
+        friend class module::Module;
     };