[MOAB-dev] r3980 - MOAB/trunk/src/io/mhdf/include

[kraftche at cae.wisc.edu]

Author: kraftche
Date: 2010-05-28 17:29:44 -0500 (Fri, 28 May 2010)
New Revision: 3980

Modified:
   MOAB/trunk/src/io/mhdf/include/mhdf.h
Log:
check in file description as big doxygen comment

Modified: MOAB/trunk/src/io/mhdf/include/mhdf.h
===================================================================
--- MOAB/trunk/src/io/mhdf/include/mhdf.h	2010-05-28 22:13:43 UTC (rev 3979)
+++ MOAB/trunk/src/io/mhdf/include/mhdf.h	2010-05-28 22:29:44 UTC (rev 3980)
@@ -56,10 +56,10 @@
  * entity ID may be used in some contexts (tag data with the mhdf_ENTITY_ID
  * property) to indicate a 'null' value,
  *
- * Element 
- * types are defined by the combination of a topology identifier (e.g. 
+ * Element types are defined by the combination of a topology identifier (e.g. 
  * hexahedral topology) and the number of nodes in the element.  
  *
+ *
  *\section Root   The \c tstt Group
  *
  * All file data is stored in the \c tstt group in the HDF5 root group.
@@ -67,9 +67,9 @@
  * named \c max_id .  This attribute, if present, should contain the
  * value of the largest entity ID used internally to the file.  It can
  * be used to verify that the code reading the file is using an integer
- * type of sufficient size to store the file IDs.  
+ * type of sufficient size to accomodate the entity IDs.  
  *
- * The \c tstt group contains four sub-groups a datatype object and a 
+ * The \c tstt group contains four sub-groups, a datatype object, and a 
  * dataset object.  The three sub-groups are: \c nodes, \c elements, 
  * \c sets, and \c tags.  The dataset is named \c history .
  *
@@ -86,13 +86,15 @@
  * - \c Hex
  * - \c Polyhedron
  * 
- *\section History The \c history DataSet
  *
+ *\section History   The \c history DataSet
+ *
  * The \c history DataSet is a list of variable-length strings with
  * appliation-defined meaning.  
  *
- *\section Nodes The \c nodes Group
+ *\section Nodes   The \c nodes Group
  *
+ *
  * The \c nodes group contains a single DataSet and an optional
  * subgroup.  The \c tags subgroup is described in the 
  * \ref Dense "section on dense tag storage".  
@@ -104,13 +106,14 @@
  * is the number of coordinate values for each vertex.
  *
  * The \c coodinates DataSet must have an integer attribute named \c start_id .