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

[jvporter at wisc.edu]

Author: jvporter
Date: 2011-03-14 16:54:09 -0500 (Mon, 14 Mar 2011)
New Revision: 4587

Modified:
   MOAB/trunk/itaps/imesh/iMesh.h
Log:
Sync iMesh.h with ITAPS-standard version


Modified: MOAB/trunk/itaps/imesh/iMesh.h
===================================================================
--- MOAB/trunk/itaps/imesh/iMesh.h	2011-03-14 21:35:25 UTC (rev 4586)
+++ MOAB/trunk/itaps/imesh/iMesh.h	2011-03-14 21:54:09 UTC (rev 4587)
@@ -928,8 +928,6 @@
      * \param instance iMesh instance handle
      * \param entity_set Entity set to be destroyed
      * \param *err Pointer to error type returned from function
-     * \note This function will fail with iBase_INVALID_ENTITYSET_HANDLE
-     *       if called with the root set.
      */
   void iMesh_destroyEntSet(iMesh_Instance instance,
                            /*in*/ iBase_EntitySetHandle entity_set,
@@ -937,14 +935,12 @@
 
     /**\brief  Return whether a specified set is ordered or unordered
      *
-     * Return whether a specified set is ordered \c (*is_list=1) or 
-     * unordered \c (*is_list=0)
+     * Return whether a specified set is ordered (*is_list=1) or 
+     * unordered (*is_list=0)
      * \param instance iMesh instance handle
      * \param entity_set Entity set being queried
      * \param is_list Pointer to flag returned from function
      * \param *err Pointer to error type returned from function
-     * \note This function will return \c (*is_list==0) if passed the
-     *       root set.
      */
   void iMesh_isList(iMesh_Instance instance,
                     /*in*/ const iBase_EntitySetHandle entity_set,
@@ -953,10 +949,7 @@
 
     /**\brief  Get the number of entity sets contained in a set or interface
      *
-     * Get the number of entity sets contained in a set or interface.  If
-     * a set is input which is not the root set, num_hops indicates the 
-     * maximum number of contained sets from entity_set_handle to one of the
-     * contained sets, not inclusive of the contained set.
+     * Get the number of entity sets contained in a set or interface.
      * \param instance iMesh instance handle
      * \param entity_set_handle Entity set being queried
      * \param num_hops Maximum hops from entity_set_handle to contained set,
@@ -974,10 +967,7 @@
 
     /**\brief  Get the entity sets contained in a set or interface
      *
-     * Get the entity sets contained in a set or interface.  If
-     * a set is input which is not the root set, num_hops indicates the 
-     * maximum number of contained sets from entity_set_handle to one of the
-     * contained sets, not inclusive of the contained set.
+     * Get the entity sets contained in a set or interface.