X-Git-Url: http://g0dil.de/git?a=blobdiff_plain;f=PPI%2FModuleManager.hh;h=4559af341c57ef95f74e1c6d0370ac4aaa1fc2b7;hb=c778649a04a9835ecaad9108b9613832d76c2d15;hp=b9441235c024c1cfb4b24576504ee3a18712496c;hpb=7231c220a7332754de3d16e4e8aacd5dbd31c501;p=senf.git

diff --git a/PPI/ModuleManager.hh b/PPI/ModuleManager.hh
index b944123..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,17 +60,17 @@ 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
@@ -78,6 +81,8 @@ namespace ppi {
         ModuleRegistry moduleRegistry_;
         bool running_;
         bool terminate_;
+
+        friend class module::Module;
     };