API/doxy: fix the documentation of hwloc_get_depth_type()

Mention virtual depths. Signed-off-by: Brice Goglin <Brice.Goglin@inria.fr> (cherry picked from commit adb340d)
open-mpi · Nov 15, 2019 · 5e1c58e · 5e1c58e
1 parent 9932909
commit 5e1c58e
Showing 1 changed file with 2 additions and 1 deletion.
diff --git a/include/hwloc.h b/include/hwloc.h
@@ -1264,7 +1264,8 @@ hwloc_get_type_or_above_depth (hwloc_topology_t topology, hwloc_obj_type_t type)
 
 /** \brief Returns the type of objects at depth \p depth.
  *
- * \p depth should between 0 and hwloc_topology_get_depth()-1.
+ * \p depth should between 0 and hwloc_topology_get_depth()-1,
+ * or a virtual depth such as ::HWLOC_TYPE_DEPTH_BRIDGE.
  *
  * \return -1 if depth \p depth does not exist.
  */