hwloc.h: doc return values for two remaining functions

bgoglin · bgoglin · commit 469b39b46ebb · 2023-04-27T16:17:46.000+02:00
Refs #578. Signed-off-by: Brice Goglin <Brice.Goglin@inria.fr>
diff --git a/include/hwloc.h b/include/hwloc.h
@@ -98,6 +98,8 @@ extern "C" {
 /** \brief Indicate at runtime which hwloc API version was used at build time.
  *
  * Should be ::HWLOC_API_VERSION if running on the same version.
+ *
+ * \return the build-time version number.
  */
 HWLOC_DECLSPEC unsigned hwloc_get_api_version(void);
 
@@ -789,6 +791,8 @@ HWLOC_DECLSPEC void hwloc_topology_check(hwloc_topology_t topology);
  *
  * This is the depth of ::HWLOC_OBJ_PU objects plus one.
  *
+ * \return the depth of the object tree.
+ *
  * \note NUMA nodes, I/O and Misc objects are ignored when computing
  * the depth of the tree (they are placed on special levels).
  */

Original file line number	Diff line number	Diff line change
`@@ -98,6 +98,8 @@ extern "C" {`
`98`	`98`	`/** \brief Indicate at runtime which hwloc API version was used at build time.`
`99`	`99`	`*`
`100`	`100`	`* Should be ::HWLOC_API_VERSION if running on the same version.`
	`101`	`+ *`
	`102`	`+ * \return the build-time version number.`
`101`	`103`	`*/`
`102`	`104`	`HWLOC_DECLSPEC unsigned hwloc_get_api_version(void);`
`103`	`105`
`@@ -789,6 +791,8 @@ HWLOC_DECLSPEC void hwloc_topology_check(hwloc_topology_t topology);`
`789`	`791`	`*`
`790`	`792`	`* This is the depth of ::HWLOC_OBJ_PU objects plus one.`
`791`	`793`	`*`
	`794`	`+ * \return the depth of the object tree.`
	`795`	`+ *`
`792`	`796`	`* \note NUMA nodes, I/O and Misc objects are ignored when computing`
`793`	`797`	`* the depth of the tree (they are placed on special levels).`
`794`	`798`	`*/`