Skip to content

Commit

Permalink
test_coordinates: tweak documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
cburstedde committed Jan 31, 2025
1 parent eb0d0c5 commit 9c25a95
Show file tree
Hide file tree
Showing 2 changed files with 4 additions and 3 deletions.
5 changes: 3 additions & 2 deletions doc/doxygen/coordinates.dox
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,7 @@
51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
*/

/** \page coordinates The p4est coordinate system
/** \page forest_coordinates The p4est coordinate system
*
* The forest-of-octrees coordinate system.
*
Expand Down Expand Up @@ -92,11 +92,12 @@
* corner at the cross of four (2D) or eight (3D) quadrants leads to the
* same coordinate tuple and derived hash from all of these perspectives.
* For an example of using this mechanism, and as a guide to use the hash
* functionality available; see \ref test_coordinates2.c (containing code
* functionality available, see \ref test_coordinates2.c (containing code
* for both the 2D and the 3D program).
*/

/** \example test_coordinates2.c
*
* Generate coordinate tuples for quadrants, uniquify and hash them.
* Please see the page on \ref forest_coordinates for further details.
*/
2 changes: 1 addition & 1 deletion test/test_coordinates2.c
Original file line number Diff line number Diff line change
Expand Up @@ -87,7 +87,7 @@ coordinates_equal_fn (const void *v1, const void *v2, const void *u)
!memcmp (k1->coords, k2->coords, P4EST_DIM * sizeof (p4est_qcoord_t));
}

/* Check whether a p4est node quadrant sits at a given coordinate tuple */
/* Check whether a p4est node quadrant sits at a given coordinate tuple */
static int
test_node_coordinates (const p4est_quadrant_t *r,
const p4est_qcoord_t coords[])
Expand Down

0 comments on commit 9c25a95

Please sign in to comment.