Fix few issues with Doxygen doc [skip ci]

src/common/API_functions.c

@@ -33,7 +33,7 @@
  * \copyright GNU Lesser General Public License.
  *
  * \note This file contains some internal functions for the API, see the \a
- * common/libmmgcommon.h, \a mmgs/libmmgs.h and \a mmg3d/libmmg3d.h header files
+ * common/libmmgcommon_private.h, \a mmgs/libmmgs.h and \a mmg3d/libmmg3d.h header files
  * for the documentation of all the usefull user's API functions.
  *
  * C API for MMG library.

src/common/API_functionsf.c

@@ -29,7 +29,7 @@
  * \date 01 2014
  * \copyright GNU Lesser General Public License.
  *
- * \note Please, refer to the \ref common/libmmgcommon.h, mmgs/libmmgs.h and
+ * \note Please, refer to the \ref common/libmmgcommon_private.h, mmgs/libmmgs.h and
  * mmg3d/libmmg3d.h header files for functions documentation.
  *
  * Define the Fortran API functions for MMG library: adds function
@@ -42,7 +42,7 @@
 
 
 /**
- * See \ref MMG5_Init_fileNames function in \ref common/libmmgcommon.h file.
+ * See \ref MMG5_Init_fileNames function in \ref common/libmmgcommon_private.h file.
  */
 FORTRAN_NAME(MMG5_INIT_FILENAMES,mmg5_init_filenames,(MMG5_pMesh *mesh,MMG5_pSol *sol),(mesh,sol)) {
 
@@ -51,7 +51,7 @@ FORTRAN_NAME(MMG5_INIT_FILENAMES,mmg5_init_filenames,(MMG5_pMesh *mesh,MMG5_pSol
 }
 
 /**
- * See \ref MMG5_Set_inputMeshName function in \ref common/libmmgcommon.h file.
+ * See \ref MMG5_Set_inputMeshName function in \ref common/libmmgcommon_private.h file.
  */
 FORTRAN_NAME(MMG5_SET_INPUTMESHNAME, mmg5_set_inputmeshname,
              (MMG5_pMesh *mesh, char *meshin, int *strlen, int *retval),
@@ -68,7 +68,7 @@ FORTRAN_NAME(MMG5_SET_INPUTMESHNAME, mmg5_set_inputmeshname,
 }
 
 /**
- * See \ref MMG5_Set_inputSolName function in \ref common/libmmgcommon.h file.
+ * See \ref MMG5_Set_inputSolName function in \ref common/libmmgcommon_private.h file.
  */
 FORTRAN_NAME(MMG5_SET_INPUTSOLNAME, mmg5_set_inputsolname,
              (MMG5_pMesh *mesh,MMG5_pSol *sol, char* solin, int* strlen, int* retval),
@@ -104,7 +104,7 @@ FORTRAN_NAME(MMG5_SET_OUTPUTMESHNAME,mmg5_set_outputmeshname,
 }
 
 /**
- * See \ref MMG5_Set_outputSolName function in \ref common/libmmgcommon.h file.
+ * See \ref MMG5_Set_outputSolName function in \ref common/libmmgcommon_private.h file.
  */
 FORTRAN_NAME(MMG5_SET_OUTPUTSOLNAME,mmg5_set_outputsolname,
              (MMG5_pMesh *mesh,MMG5_pSol *sol, char* solout,int* strlen, int* retval),
@@ -121,7 +121,7 @@ FORTRAN_NAME(MMG5_SET_OUTPUTSOLNAME,mmg5_set_outputsolname,
 }
 
 /**
- * See \ref MMG5_scaleMesh function in \ref common/libmmgcommon.h file.
+ * See \ref MMG5_scaleMesh function in \ref common/libmmgcommon_private.h file.
  */
 FORTRAN_NAME(MMG5_SCALEMESH,mmg5_scalemesh,
              (MMG5_pMesh *mesh,MMG5_pSol *met,MMG5_pSol *ls,int* retval),
@@ -133,7 +133,7 @@ FORTRAN_NAME(MMG5_SCALEMESH,mmg5_scalemesh,
 }
 
 /**
- * See \ref MMG5_unscaleMesh function in \ref common/libmmgcommon.h file.
+ * See \ref MMG5_unscaleMesh function in \ref common/libmmgcommon_private.h file.
  */
 FORTRAN_NAME(MMG5_UNSCALEMESH,mmg5_unscalemesh,
              (MMG5_pMesh *mesh,MMG5_pSol *met,MMG5_pSol *ls,int* retval),
@@ -145,7 +145,7 @@ FORTRAN_NAME(MMG5_UNSCALEMESH,mmg5_unscalemesh,
 }
 
 /**
- * See \a MMG5_unscaleMesh function in \ref common/libmmgcommon.h file.
+ * See \a MMG5_unscaleMesh function in \ref common/libmmgcommon_private.h file.
  */
 FORTRAN_NAME(MMG5_MMGFREE_NAMES,mmg5_mmgfree_names,(MMG5_pMesh *mesh
                                                     ,MMG5_pSol *met

src/common/anisosiz.c

@@ -758,7 +758,7 @@ int MMG5_solveDefmetrefSys( MMG5_pMesh mesh, MMG5_pPoint p0, MMG5_int ipref[2],
  \left(\frac{d-1}{d} \right)^2.
  \f]
  *
- * See Theorem 1 of \cite{dapogny2014three}.
+ * See Theorem 1 of \cite dapogny2014three.
  *
  **/
 double MMG5_ridSizeInTangentDir(MMG5_pMesh mesh, MMG5_pPoint p0, MMG5_int idp,

src/mmg2d/API_functionsf_2d.c

@@ -42,7 +42,7 @@
 #include "libmmg2d_private.h"
 
 /**
- * See \ref MMG2D_Init_mesh function in common/libmmgcommon.h file.
+ * See \ref MMG2D_Init_mesh function in common/libmmgcommon_private.h file.
  */
 FORTRAN_VARIADIC ( MMG2D_INIT_MESH, mmg2d_init_mesh,
                    (const int starter, ... ),
@@ -77,7 +77,7 @@ FORTRAN_NAME(MMG2D_INIT_PARAMETERS, mmg2d_init_parameters,(MMG5_pMesh *mesh),
   return;
 }
 /**
- * See \ref MMG2D_Set_inputMeshName function in \ref common/libmmgcommon.h file.
+ * See \ref MMG2D_Set_inputMeshName function in \ref common/libmmgcommon_private.h file.
  */
 FORTRAN_NAME(MMG2D_SET_INPUTMESHNAME, mmg2d_set_inputmeshname,
              (MMG5_pMesh *mesh, char* meshin, int *strlen0, int* retval),
@@ -94,7 +94,7 @@ FORTRAN_NAME(MMG2D_SET_INPUTMESHNAME, mmg2d_set_inputmeshname,
 }
 
 /**
- * See \ref MMG2D_Set_inputSolName function in \ref common/libmmgcommon.h file.
+ * See \ref MMG2D_Set_inputSolName function in \ref common/libmmgcommon_private.h file.
  */
 FORTRAN_NAME(MMG2D_SET_INPUTSOLNAME, mmg2d_set_inputsolname,
              (MMG5_pMesh *mesh,MMG5_pSol *sol, char* solin, int* strlen0, int* retval),
@@ -130,7 +130,7 @@ FORTRAN_NAME(MMG2D_SET_OUTPUTMESHNAME,mmg2d_set_outputmeshname,
 }
 
 /**
- * See \ref MMG2D_Set_outputSolName function in \ref common/libmmgcommon.h file.
+ * See \ref MMG2D_Set_outputSolName function in \ref common/libmmgcommon_private.h file.
  */
 FORTRAN_NAME(MMG2D_SET_OUTPUTSOLNAME,mmg2d_set_outputsolname,
              (MMG5_pMesh *mesh,MMG5_pSol *sol, char* solout,int* strlen0, int* retval),

src/mmg2d/lissmet_2d.c

@@ -40,7 +40,7 @@
  * \return 0 if fail, 1 if success
  *
  * Anisotropic gradation (h-gradation procedure). See:
- * \cite{borouchaki1998mesh}. The Hc-correction method is used (gradation with
+ * \cite borouchaki1998mesh. The Hc-correction method is used (gradation with
  * respect to H-shock measure). Skip edges with a required extremity (treated
  * in lissmetreq_ani).
  */

src/mmg3d/API_functionsf_3d.c

@@ -42,7 +42,7 @@
 #include "libmmg3d.h"
 
 /**
- * See \ref MMG3D_Init_mesh function in common/libmmgcommon.h file.
+ * See \ref MMG3D_Init_mesh function in common/libmmgcommon_private.h file.
  */
 FORTRAN_VARIADIC ( MMG3D_INIT_MESH, mmg3d_init_mesh,
                    (const int starter, ... ),
@@ -121,7 +121,7 @@ FORTRAN_NAME(MMG3D_SET_OUTPUTMESHNAME,mmg3d_set_outputmeshname,
 }
 
 /**
- * See \ref MMG3D_Set_outputSolName function in \ref common/libmmgcommon.h file.
+ * See \ref MMG3D_Set_outputSolName function in \ref common/libmmgcommon_private.h file.
  */
 FORTRAN_NAME(MMG3D_SET_OUTPUTSOLNAME,mmg3d_set_outputsolname,
              (MMG5_pMesh *mesh,MMG5_pSol *sol, char* solout,int* strlen0, int* retval),

src/mmg3d/anisosiz_3d.c

@@ -1432,7 +1432,7 @@ int MMG3D_defsiz_ani(MMG5_pMesh mesh,MMG5_pSol met) {
  *
  * Get metric tensor from metric structure (pass from ridge storage to classical
  * storage on non-singular ridge points, copy metric on all other points).
- * See: \cite{borouchaki1998mesh}. The Hv-correction
+ * See: \cite borouchaki1998mesh. The Hv-correction
  * is used (gradation with respect to H-variation measure).
  */
 static inline

src/mmg3d/bezier_3d.c

@@ -318,7 +318,7 @@ MMG5_BezierEdge(MMG5_pMesh mesh,MMG5_int ip0,MMG5_int ip1,double b0[3],
  * \param ori triangle orientation.
  * \return 1.
  *
- * Compute Bezier control points on triangle \a pt (cf. \cite{vlachos2001curved})
+ * Compute Bezier control points on triangle \a pt (cf. \cite vlachos2001curved)
  *
  * \todo merge with the MMG5_mmgsBezierCP function and remove the pointer
  * toward this functions.

src/mmgs/API_functionsf_s.c

@@ -41,7 +41,7 @@
 #include "libmmgs_private.h"
 
 /**
- * See \ref MMGS_Init_mesh function in common/libmmgcommon.h file.
+ * See \ref MMGS_Init_mesh function in common/libmmgcommon_private.h file.
  */
 FORTRAN_VARIADIC ( MMGS_INIT_MESH, mmgs_init_mesh,
                    (const int starter, ... ),
@@ -66,7 +66,7 @@ FORTRAN_NAME(MMGS_INIT_PARAMETERS,mmgs_init_parameters,(MMG5_pMesh *mesh),(mesh)
   return;
 }
 /**
- * See \ref MMGS_Set_inputMeshName function in \ref common/libmmgcommon.h file.
+ * See \ref MMGS_Set_inputMeshName function in \ref common/libmmgcommon_private.h file.
  */
 FORTRAN_NAME(MMGS_SET_INPUTMESHNAME, mmgs_set_inputmeshname,
              (MMG5_pMesh *mesh, char* meshin, int *strlen0, int* retval),
@@ -83,7 +83,7 @@ FORTRAN_NAME(MMGS_SET_INPUTMESHNAME, mmgs_set_inputmeshname,
 }
 
 /**
- * See \ref MMGS_Set_inputSolName function in \ref common/libmmgcommon.h file.
+ * See \ref MMGS_Set_inputSolName function in \ref common/libmmgcommon_private.h file.
  */
 FORTRAN_NAME(MMGS_SET_INPUTSOLNAME, mmgs_set_inputsolname,
              (MMG5_pMesh *mesh,MMG5_pSol *sol, char* solin, int* strlen0, int* retval),
@@ -119,7 +119,7 @@ FORTRAN_NAME(MMGS_SET_OUTPUTMESHNAME,mmgs_set_outputmeshname,
 }
 
 /**
- * See \ref MMGS_Set_outputSolName function in \ref common/libmmgcommon.h file.
+ * See \ref MMGS_Set_outputSolName function in \ref common/libmmgcommon_private.h file.
  */
 FORTRAN_NAME(MMGS_SET_OUTPUTSOLNAME,mmgs_set_outputsolname,
              (MMG5_pMesh *mesh,MMG5_pSol *sol, char* solout,int* strlen0, int* retval),

src/mmgs/bezier_s.c

@@ -45,7 +45,7 @@ extern int8_t ddb;
  * with the MMG5_bezierCP interface).
  * \return 1.
  *
- * Compute Bezier control points on triangle \a pt (cf. \cite{vlachos2001curved}).
+ * Compute Bezier control points on triangle \a pt (cf. \cite vlachos2001curved).
  *
  * \todo merge with the MMG5_mmg3dBezierCP function and remove the pointer
  * toward this functions.