[MOAB-dev] r4114 - MOAB/trunk/itaps/imesh

[kraftche at cae.wisc.edu]

Author: kraftche
Date: 2010-08-31 11:26:54 -0500 (Tue, 31 Aug 2010)
New Revision: 4114

Modified:
   MOAB/trunk/itaps/imesh/iMesh.h
Log:
merge changes from ITAPS repo: documentation changes and some version macros

Modified: MOAB/trunk/itaps/imesh/iMesh.h
===================================================================
--- MOAB/trunk/itaps/imesh/iMesh.h	2010-08-31 16:14:06 UTC (rev 4113)
+++ MOAB/trunk/itaps/imesh/iMesh.h	2010-08-31 16:26:54 UTC (rev 4114)
@@ -1,9 +1,26 @@
 #ifndef _ITAPS_iMesh
 #define _ITAPS_iMesh
 
-#define IMESH_MAJOR_VERSION 0
-#define IMESH_MINOR_VERSION 8
+  /**\brief iMesh Interface Specification Major Release Number
+    */
+#define IMESH_MAJOR_VERSION 1
 
+  /**\brief iMesh Interface Specification Minor Release Number
+    */
+#define IMESH_MINOR_VERSION 0
+
+  /**\brief iMesh Interface Specification Patch Release Number
+    *
+    * Technically speaking, there is not much practical value in
+    * a 'patch' digit for an interface specification. A 'patch'
+    * release is typically only used for bug fix releases. That
+    * is unlikely to apply to an interface specification such as
+    * iMesh. Nonetheless, there is non-technical value in having
+    * a bit finer grained control over version numbers that a patch
+    * digit affords. So, we define one for iMesh.
+    */
+#define IMESH_PATCH_VERSION 0
+
   /** \mainpage The ITAPS Mesh Interface iMesh
    *
    * The ITAPS Mesh Interface iMesh provides a common interface for
@@ -13,7 +30,7 @@
    * to this interface, for example mesh smoothing, adaptive mesh refinement,
    * and parallel mesh support.
    *
-   * \section DataModel Data Model
+   * \section ITAPS Data Model
    *
    * The ITAPS interfaces use a data model composed of four basic data types: \n
    * \em Entity: basic topological entities in a mesh, e.g. vertices, 
@@ -28,7 +45,7 @@
    * \em Tag: application data associated with objects of any of the other 
    * data types.  Each tag has a designated name, size, and data type.
    *
-   * \section JTAPS Entity Type, Topology
+   * \section ITAPS Entity Type, Topology
    * Each entity has a specific Entity Type and Entity Topology.  The Entity 
    * Type is one of VERTEX, EDGE, FACE, and REGION, and is synonymous with
    * the topological dimension of the entity.  The Entity Topology denotes