a few doxygen documentation
authorFilippo Gioachin <gioachin@illinois.edu>
Sun, 4 Dec 2005 00:53:57 +0000 (00:53 +0000)
committerFilippo Gioachin <gioachin@illinois.edu>
Sun, 4 Dec 2005 00:53:57 +0000 (00:53 +0000)
src/ck-com/ComlibManager.C
src/ck-com/ComlibManager.h

index 4d54cd14588d9009a10a6c6cd06ff555ddc7443d..b1a68f494acbdbc278750818a46580e955f5a4b5 100644 (file)
@@ -1,4 +1,7 @@
-
+/**
+   @addtogroup Comlib
+*/
+/*@{*/
 #include "ComlibManager.h"
 #include "EachToManyMulticastStrategy.h"
 #include "DirectMulticastStrategy.h"
@@ -1172,4 +1175,4 @@ void ComlibLBMigrationUpdate(LBMigrateMsg *msg) {
 
 #include "comlib.def.h"
 
-
+/*@}*/
index b03fba224b2cc6f252d72d71888bd41a9ed491c3..57a8eca7b15db9bd4408b64ff8bb762a0517470e 100644 (file)
@@ -1,6 +1,11 @@
 #ifndef COMMLIBMANAGER_H
 #define COMMLIBMANAGER_H
 
+/**
+   @defgroup Comlib  Charm++ Communication Optimization Framework 
+*/
+/*@{*/
+
 #include "charm++.h"
 #include "cksection.h"
 #include "envelope.h"
@@ -22,8 +27,8 @@ PUPbytes(comID);
 
 #include "comlib.decl.h"
 
-//Dummy message to be sent incase there are no messages to send. 
-//Used by only the EachToMany strategy!
+///Dummy message to be sent in case there are no messages to send. 
+///Used by only the EachToMany strategy!
 class ComlibDummyMsg: public CMessage_ComlibDummyMsg {
     int dummy;
 };
@@ -73,7 +78,9 @@ class ComlibMulticastMsg : public CkMcastBaseMsg,
 
 class ComlibManager;
 
-//An Instance of the communication library.
+/** An Instance of the communication library. It can be seen as the proxy given
+    by ComlibManager upon registration of a strategy to the framework.
+ */
 class ComlibInstanceHandle : public CkDelegateData {
  private:    
     int _instid;
@@ -114,6 +121,12 @@ class ComlibInstanceHandle : public CkDelegateData {
 
 class LBMigrateMsg;
 
+/** The main group doing the management of all the system. It takes care of
+    holding all the registered strategies, calling them when a message arrives,
+    and modifying them when needed by the learning framework. It installed
+    itself as a delegated class from CkDelegateMgr, overwriting the standard
+    path of message sending in charm.
+ */
 class ComlibManager: public CkDelegateMgr {
     friend class ComlibInstanceHandle;
 
@@ -131,9 +144,9 @@ class ComlibManager: public CkDelegateMgr {
     CkArrayIndexMax dummyArrayIndex;
 
     //For compatibility and easier use!
-    int strategyID; //Identifier of the strategy
+    int strategyID; //<Identifier of the strategy
 
-    //Pointer to the converse comm lib strategy table
+    ///Pointer to the converse comm lib strategy table
     StrategyTable *strategyTable;
 
     CkQ<CharmStrategy *> ListOfStrategies; //temporary list of strategies
@@ -166,21 +179,21 @@ class ComlibManager: public CkDelegateMgr {
                                //each of which is triggered by a
                                //loadbalancing operation
 
-    void init(); //initialization function
+    void init(); ///Initialization function
 
     //charm_message for multicast for a section of that group
     void multicast(CharmMessageHolder *cmsg); //charm message holder here
     //void multicast(void *charm_msg, int npes, int *pelist);
 
     //The following funtions can be accessed only from ComlibInstanceHandle
-    void beginIteration();     //Notify begining of a bracket with
-                               //strategy identifier
-
-    void endIteration();       //Notify end, endIteration must be
-                               //called if a beginIteration is
-                               //called. Otherwise end of the entry
-                               //method is assumed to be the end of
-                               //the bracket.
+    void beginIteration();     ///Notify begining of a bracket with
+                               ///strategy identifier
+
+    void endIteration();       ///Notify end, endIteration must be
+                               ///called if a beginIteration is
+                               ///called. Otherwise end of the entry
+                               ///method is assumed to be the end of
+                               ///the bracket.
     
     void setInstance(int id); 
 
@@ -299,4 +312,6 @@ void ComlibLBMigrationUpdate(LBMigrateMsg *);
         cgproxy.ckLocalBranch()->clib_stats.recordRecvM(sid, bytes, src_arr, nsrc); \
 }\
 
+/*@}*/
+
 #endif