p?est_search.h: documentation fixes/updates

cburstedde · Feb 7, 2025 · 8ae4c94 · 8ae4c94
1 parent 826a3c2
commit 8ae4c94
Show file tree

Hide file tree

Showing 3 changed files with 8 additions and 6 deletions.
diff --git a/src/p4est_search.h b/src/p4est_search.h
@@ -308,8 +308,8 @@ void                p4est_search (p4est_t * p4est,
  *                          contains its tree number.  Sorted ascending.
  * \param [in,out] indices  This array holds \ref p4est_topidx_t types.
  *                          Sorted ascending on input.  May be permuted and
- *                          subset by this function.  It is explicitly allowed
- *                          to \ref sc_array_resize to smaller length.
+ *                          subset by this function.  It is explicitly
+ *                          allowed to resize it to a smaller length.
  *                          An output length of zero stops recursion.
  * \return                  Return false to break the search recursion.
  */

diff --git a/src/p6est_ghost.h b/src/p6est_ghost.h
@@ -122,7 +122,8 @@ void                p6est_ghost_destroy (p6est_ghost_t * ghost);
  * \param [in] ghost            The ghost layer.
  * \param [in] which_proc       The owner of the searched quadrant.  Can be -1.
  * \param [in] which_tree       The tree of the searched quadrant.  Can be -1.
- * \param [in] q                Valid quadrant is searched in the ghost layer.
+ * \param [in] column           The column that is being searched for.
+ * \param [in] layer            The layer that is being searched for.
  * \return                      Offset in the ghost layer, or -1 if not found.
  */
 ssize_t             p6est_ghost_bsearch (p6est_ghost_t * ghost,
@@ -135,7 +136,8 @@ ssize_t             p6est_ghost_bsearch (p6est_ghost_t * ghost,
  * \param [in] ghost            The ghost layer.
  * \param [in] which_proc       The owner of the searched quadrant.  Can be -1.
  * \param [in] which_tree       The tree of the searched quadrant.  Can be -1.
- * \param [in] q                Valid quadrant's ancestor is searched.
+ * \param [in] column           The column that is being searched for.
+ * \param [in] layer            The layer that is being searched for.
  * \return                      Offset in the ghost layer, or -1 if not found.
  */
 ssize_t             p6est_ghost_contains (p6est_ghost_t * ghost,

diff --git a/src/p8est_search.h b/src/p8est_search.h
@@ -311,8 +311,8 @@ void                p8est_search (p8est_t * p4est,
  *                          contains its tree number.  Sorted ascending.
  * \param [in,out] indices  This array holds \ref p4est_topidx_t types.
  *                          Sorted ascending on input.  May be permuted and
- *                          subset by this function.  It is explicitly allowed
- *                          to \ref sc_array_resize to smaller length.
+ *                          subset by this function.  It is explicitly
+ *                          allowed to resize it to a smaller length.
  *                          An output length of zero stops recursion.
  * \return                  Return false to break the search recursion.
  */