[MOAB-dev] r4268 - MOAB/trunk/itaps/igeom

[jvporter at wisc.edu]

Author: jvporter
Date: 2010-11-15 15:36:28 -0600 (Mon, 15 Nov 2010)
New Revision: 4268

Modified:
   MOAB/trunk/itaps/igeom/iGeom.h
Log:
Update iGeom docs re: num_hops


Modified: MOAB/trunk/itaps/igeom/iGeom.h
===================================================================
--- MOAB/trunk/itaps/igeom/iGeom.h	2010-11-15 21:22:46 UTC (rev 4267)
+++ MOAB/trunk/itaps/igeom/iGeom.h	2010-11-15 21:36:28 UTC (rev 4268)
@@ -2303,11 +2303,11 @@
      * 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, inclusive of the contained set.
+     * contained sets, not inclusive of the contained set.
      * \param instance iGeom instance handle
      * \param entity_set_handle Entity set being queried
      * \param num_hops Maximum hops from entity_set_handle to contained set,
-     *        inclusive of the contained set
+     *        not inclusive of the contained set
      * \param num_sets Pointer to the number of sets returned from function
      * \param *err Pointer to error type returned from function
      */
@@ -2323,11 +2323,11 @@
      * 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, inclusive of the contained set.
+     * contained sets, not inclusive of the contained set.
      * \param instance iGeom instance handle
      * \param entity_set_handle Entity set being queried
      * \param num_hops Maximum hops from entity_set_handle to contained set,
-     *        inclusive of the contained set
+     *        not inclusive of the contained set
      * \param *contained_set_handles Pointer to array of set handles returned
      *        from function
      * \param contained_set_handles_allocated Pointer to allocated length of
@@ -2530,12 +2530,12 @@
     /**\brief  Get the number of child sets linked from a specified set
      *
      * Get the number of child sets linked from a specified set.  If num_hops
-     * is non-zero, this represents the maximum hops from entity_set to any
+     * is not -1, this represents the maximum hops from entity_set to any
      * child in the count.
      * \param instance iGeom instance handle
      * \param entity_set Entity set being queried
      * \param num_hops Maximum hops from entity_set_handle to child set,
-     *        inclusive of the child set
+     *        not inclusive of the child set
      * \param num_child Pointer to number of children returned from function
      * \param *err Pointer to error type returned from function
      */
@@ -2548,12 +2548,12 @@
     /**\brief  Get the number of parent sets linked from a specified set
      *
      * Get the number of parent sets linked from a specified set.  If num_hops