Documentation: fix various doxygen warnings

src/p4est.h

@@ -48,10 +48,14 @@ SC_EXTERN_C_BEGIN;
 
 /** The finest level of the quadtree for representing nodes */
 #define P4EST_OLD_MAXLEVEL 30   /* in 2D, the maxlevel has always been 30 */
+
+/** The finest level for representing quadrant midpoint coordinates */
 #define P4EST_MAXLEVEL 30
 
 /** The finest level of the quadtree for representing quadrants */
 #define P4EST_OLD_QMAXLEVEL 29  /* in 2D, the qmaxlevel has always been 29 */
+
+/** The finest level of the quadtree for representing quadrant corners */
 #define P4EST_QMAXLEVEL 29
 
 /** The length of a side of the root quadrant */

src/p4est_bits.h

@@ -383,6 +383,7 @@ void                p4est_quadrant_enlarge_last (const p4est_quadrant_t * a,
                                                  p4est_quadrant_t * q);
 
 /** Generate the root quadrant of any tree.
+ * Equivalent to \ref p4est_quadrant_set_morton with all-zero parameters.
  * \param [out] root    Quadrant structure's coordinates and level are set.
  *                      As with all other functions that generate or
  *                      modify quadrants, the other bits of the structured

src/p6est.h

@@ -110,8 +110,10 @@ void                p6est_tree_get_vertices (p6est_connectivity_t * conn,
  *
  * \param [in] connectivity     Connectivity must provide the vertices.
  * \param [in] treeid           Identify the tree that contains x, y.
- * \param [in] x, y             Quadrant coordinates relative to treeid.
- * \param [out] vxy             Transformed coordinates in vertex space.
+ * \param [in] x                Quadrant coordinate relative to treeid.
+ * \param [in] y                Quadrant coordinate relative to treeid.
+ * \param [in] z                Quadrant coordinate relative to treeid.
+ * \param [out] vxyz            Transformed coordinates in vertex space.
  */
 void                p6est_qcoord_to_vertex (p6est_connectivity_t *
                                             connectivity,

src/p6est_extended.h

@@ -48,6 +48,8 @@ SC_EXTERN_C_BEGIN;
  * This is a more general form of p6est_new().
  * See the documentation of p6est_new() for basic usage.
  *
+ * \param [in] mpicomm          Used und remembered in the result.
+ * \param [in] connectivity     Valid connectivity of tree topologies.
  * \param [in] min_quadrants    Minimum initial quadrants per processor.
  *                              Makes the refinement pattern mpisize-specific.
  * \param [in] min_level        The forest is horizontally refined at least to
@@ -62,6 +64,10 @@ SC_EXTERN_C_BEGIN;
  *                              instead of the coarsest possible one.
  *                              The latter is partition-specific so that
  *                              is usually not a good idea.
+ * \param [in] data_size        Size of per-quadrant stored user data.
+ * \param [in] init_fn          If not NULL, called on every quadrant created.
+ * \param [in] user_pointer     Stored as is in the result for later reference.
+ * \return                      A valid forest structure.
  */
 p6est_t            *p6est_new_ext (sc_MPI_Comm mpicomm,
                                    p6est_connectivity_t * connectivity,

src/p8est.h

@@ -44,10 +44,14 @@ SC_EXTERN_C_BEGIN;
 
 /** The finest level of the octree for representing nodes */
 #define P8EST_OLD_MAXLEVEL 19   /* old means prior to mid-2020 */
+
+/** The finest level for representing quadrant midpoint coordinates */
 #define P8EST_MAXLEVEL 30
 
 /** The finest level of the octree for representing octants */
 #define P8EST_OLD_QMAXLEVEL 18  /* old means prior to mid-2020 */
+
+/** The finest level of the quadtree for representing quadrant corners */
 #define P8EST_QMAXLEVEL 29
 
 /** The length of a side of the root quadrant */

src/p8est_bits.h

@@ -413,6 +413,7 @@ void                p8est_quadrant_enlarge_last (const p8est_quadrant_t * a,
                                                  p8est_quadrant_t * q);
 
 /** Generate the root quadrant of any tree.
+ * Equivalent to \ref p8est_quadrant_set_morton with all-zero parameters.
  * \param [out] root    Quadrant structure's coordinates and level are set.
  *                      As with all other functions that generate or
  *                      modify quadrants, the other bits of the structured