doxy: split the distances_add section into add and remove sections

Signed-off-by: Brice Goglin <Brice.Goglin@inria.fr>
open-mpi · Apr 13, 2021 · 88f3e2f · 88f3e2f
1 parent ad7d08c
commit 88f3e2f
Show file tree

Hide file tree

Showing 2 changed files with 9 additions and 1 deletion.
diff --git a/doc/Makefile.am b/doc/Makefile.am
@@ -678,6 +678,7 @@ man3_distances_DATA = \
         $(DOX_MAN_DIR)/man3/hwloc_distances_add_create.3 \
         $(DOX_MAN_DIR)/man3/hwloc_distances_add_values.3 \
         $(DOX_MAN_DIR)/man3/hwloc_distances_add_commit.3 \
+        $(DOX_MAN_DIR)/man3/hwlocality_distances_remove.3 \
         $(DOX_MAN_DIR)/man3/hwloc_distances_remove.3 \
         $(DOX_MAN_DIR)/man3/hwloc_distances_remove_by_depth.3 \
         $(DOX_MAN_DIR)/man3/hwloc_distances_remove_by_type.3 \

diff --git a/include/hwloc/distances.h b/include/hwloc/distances.h
@@ -280,7 +280,7 @@ hwloc_distances_obj_pair_values(struct hwloc_distances_s *distances,
 
 
 
-/** \defgroup hwlocality_distances_add Add or remove distances between objects
+/** \defgroup hwlocality_distances_add Add distances between objects
  *
  * The usual way to add distances is:
  * \code
@@ -389,6 +389,13 @@ HWLOC_DECLSPEC int hwloc_distances_add_commit(hwloc_topology_t topology,
                                               hwloc_distances_add_handle_t handle,
                                               unsigned long flags);
 
+/** @} */
+
+
+
+/** \defgroup hwlocality_distances_remove Remove distances between objects
+ * @{
+ */
 
 /** \brief Remove all distance matrices from a topology.
  *