domain_new_p4est: Polish documentation

ForestClaw · Oct 23, 2023 · 89f6aed · 89f6aed
1 parent 5b16e77
commit 89f6aed
Show file tree

Hide file tree

Showing 2 changed files with 6 additions and 4 deletions.
diff --git a/src/fclaw2d_convenience.h b/src/fclaw2d_convenience.h
@@ -43,8 +43,9 @@ extern "C"
  *
  * \param [in,out]    p4est   The p4est that is used to create the domain.
  *                            p4est->user_pointer must be NULL and will be
- *                            changed. The data size will be set to 0 and the
- *                            quadrant data will be freed.
+ *                            changed to pointing to a p4est_wrap created using
+ *                            the given p4est. The data size of the p4est will
+ *                            be set to 0 and its quadrant data will be freed.
  * \return                    A domain that is constructed based on the given
  *                            p4est and in particular with a pp based on the
  *                            given p4est.

diff --git a/src/fclaw3d_convenience.h b/src/fclaw3d_convenience.h
@@ -43,8 +43,9 @@ extern "C"
  *
  * \param [in,out]    p8est   The p8est that is used to create the domain.
  *                            p8est->user_pointer must be NULL and will be
- *                            changed. The data size will be set to 0 and the
- *                            quadrant data will be freed.
+ *                            changed to pointing to a p8est_wrap created using
+ *                            the given p8est. The data size of the p8est will
+ *                            be set to 0 and its quadrant data will be freed.
  * \return                    A domain that is constructed based on the given
  *                            p8est and in particular with a pp based on the
  *                            given p8est.