added small description of Converse, for doxygen
authorFilippo Gioachin <gioachin@illinois.edu>
Tue, 8 Mar 2005 05:35:03 +0000 (05:35 +0000)
committerFilippo Gioachin <gioachin@illinois.edu>
Tue, 8 Mar 2005 05:35:03 +0000 (05:35 +0000)
src/conv-core/convcore.c

index c2a0e4b83640cfaf27f5ee92e892f06d4eaaa7d6..d33eb9cc2a5e2a832c6e4b67ce4728e0ebb0842e 100644 (file)
@@ -4,16 +4,38 @@
  * $Date$
  * $Revision$
  *****************************************************************************/
-/**
-\file
-\brief Converse--a parallel portability layer.
-*/
-/**
-\addtogroup Converse
-\brief Converse--a parallel portability layer.
 
+/** @defgroup Converse
+ * \brief Converse--a parallel portability layer.
+
+ * Converse is the lowest level inside the Charm++ hierarchy. It stands on top
+ * of the machine layer, and it provides all the common functionality across
+ * platforms.
+
+ * One converse program is running on every processor (or node in the smp
+ * version). it manages the message transmission, and the memory allocation.
+ * Charm++, which is on top of Converse, uses its functionality for
+ * interprocess *communication.
+
+ * In order to maintain multiple independent objects inside a single user space
+ * program, it uses a personalized version of threads, which can be executed,
+ * suspended, and migrated across processors.
+
+ * It provides a scheduler for message delivery: methods can be registered to
+ * the scheduler, and then messages allocated through CmiAlloc can be sent to
+ * the correspondent method in a remote processor. This is done through the
+ * converse header (which has few common fields, but is architecture dependent).
 */
-/*@{*/
+
+/** @file
+ * converse main core
+ * @ingroup Converse
+ */
+
+/**
+ * @addtogroup Converse
+ * @{
+ */
 
 #include <stdio.h>
 #include <stdlib.h>
@@ -2410,3 +2432,4 @@ unsigned char computeCheckSum(unsigned char *data, int len)
   return ret;
 }
 
+/*@}*/