Merge pull request xiaoyeli#150 from gruenich/feature/improve-doxygen

Fix some Doxygen warnings
gruenich · Aug 6, 2024 · 67bdc36 · 67bdc36
2 parents 18958c3 + cfe25cb
commit 67bdc36
Show file tree

Hide file tree

Showing 22 changed files with 29 additions and 29 deletions.
diff --git a/DOC/modules.txt b/DOC/modules.txt
@@ -3,21 +3,21 @@
  */
 
 /*!
- \defgroup Common
+ \defgroup Common Common
  \brief Common code shared within SuperLU.
 
  Type-independent code.
  */
 
 /*!
- \defgroup Example
+ \defgroup Example Example
  \brief Examples of how to use SuperLU.
 
  Various examples.
  */
 
 /*!
- \defgroup Testing
+ \defgroup Testing Testing
  \brief Test that SuperLU works as intended.
 
  Tests should be run and remain working when SuperLU code is modified.
@@ -26,31 +26,31 @@
  */
 
 /*!
- \defgroup TestingC
+ \defgroup TestingC Testing Complex Float
  \ingroup Testing
  \brief Tests for complex float.
 
  These tests start with the letter c.
  */
 
 /*!
- \defgroup TestingD
+ \defgroup TestingD Testing Double
  \ingroup Testing
  \brief Tests for double.
 
  These tests start with the letter d.
  */
 
 /*!
- \defgroup TestingS
+ \defgroup TestingS Testing Float
  \ingroup Testing
  \brief Tests for float.
 
  These tests start with the letter s.
  */
 
 /*!
- \defgroup TestingZ
+ \defgroup TestingZ Testing Complex Double
  \ingroup Testing
  \brief Tests for complex double.
 

diff --git a/EXAMPLE/citersol.c b/EXAMPLE/citersol.c
@@ -16,7 +16,7 @@ at the top-level directory.
  * August, 2011
  */
 
-/*! @file citersol.c
+/*! \file
  * \brief Example #1 showing how to use ILU to precondition GMRES
  *
  * This example shows that ILU is computed from the equilibrated matrix,

diff --git a/EXAMPLE/citersol1.c b/EXAMPLE/citersol1.c
@@ -16,7 +16,7 @@ at the top-level directory.
  * August, 2011
  */
 
-/*! @file citersol1.c
+/*! \file
  * \brief Example #2 showing how to use ILU to precondition GMRES
  *
  * This example shows that ILU is computed from the equilibrated matrix,

diff --git a/EXAMPLE/ditersol.c b/EXAMPLE/ditersol.c
@@ -16,7 +16,7 @@ at the top-level directory.
  * August, 2011
  */
 
-/*! @file ditersol.c
+/*! \file
  * \brief Example #1 showing how to use ILU to precondition GMRES
  *
  * This example shows that ILU is computed from the equilibrated matrix,

diff --git a/EXAMPLE/ditersol1.c b/EXAMPLE/ditersol1.c
@@ -16,7 +16,7 @@ at the top-level directory.
  * August, 2011
  */
 
-/*! @file ditersol1.c
+/*! \file
  * \brief Example #2 showing how to use ILU to precondition GMRES
  *
  * This example shows that ILU is computed from the equilibrated matrix,

diff --git a/EXAMPLE/sitersol.c b/EXAMPLE/sitersol.c
@@ -16,7 +16,7 @@ at the top-level directory.
  * August, 2011
  */
 
-/*! @file sitersol.c
+/*! \file
  * \brief Example #1 showing how to use ILU to precondition GMRES
  *
  * This example shows that ILU is computed from the equilibrated matrix,

diff --git a/EXAMPLE/sitersol1.c b/EXAMPLE/sitersol1.c
@@ -16,7 +16,7 @@ at the top-level directory.
  * August, 2011
  */
 
-/*! @file sitersol1.c
+/*! \file
  * \brief Example #2 showing how to use ILU to precondition GMRES
  *
  * This example shows that ILU is computed from the equilibrated matrix,

diff --git a/EXAMPLE/sp_ienv.c b/EXAMPLE/sp_ienv.c
@@ -1,4 +1,4 @@
-/*! \file
+/*
 Copyright (c) 2003, The Regents of the University of California, through
 Lawrence Berkeley National Laboratory (subject to receipt of any required 
 approvals from U.S. Dept. of Energy) 
@@ -8,7 +8,7 @@ All rights reserved.
 The source code is distributed under BSD license, see the file License.txt
 at the top-level directory.
 */
-/*! @file SRC/sp_ienv.c
+/*! \file
  * \brief Chooses machine-dependent parameters for the local environment.
  *
  * <pre>

diff --git a/EXAMPLE/zitersol.c b/EXAMPLE/zitersol.c
@@ -16,7 +16,7 @@ at the top-level directory.
  * August, 2011
  */
 
-/*! @file zitersol.c
+/*! \file
  * \brief Example #1 showing how to use ILU to precondition GMRES
  *
  * This example shows that ILU is computed from the equilibrated matrix,

diff --git a/EXAMPLE/zitersol1.c b/EXAMPLE/zitersol1.c
@@ -16,7 +16,7 @@ at the top-level directory.
  * August, 2011
  */
 
-/*! @file zitersol1.c
+/*! \file
  * \brief Example #2 showing how to use ILU to precondition GMRES
  *
  * This example shows that ILU is computed from the equilibrated matrix,

diff --git a/SRC/cgsisx.c b/SRC/cgsisx.c
@@ -373,7 +373,7 @@ at the top-level directory.
  * mem_usage (output) mem_usage_t*
  *	   Record the memory usage statistics, consisting of following fields:
  *	   - for_lu (float)
- *	     The amount of space used in bytes for L\U data structures.
+ *	     The amount of space used in bytes for L\\U data structures.
  *	   - total_needed (float)
  *	     The amount of space needed in bytes to perform factorization.
  *	   - expansions (int)

diff --git a/SRC/cgssvx.c b/SRC/cgssvx.c
@@ -324,7 +324,7 @@ at the top-level directory.
  * mem_usage (output) mem_usage_t*
  *         Record the memory usage statistics, consisting of following fields:
  *         - for_lu (float)
- *           The amount of space used in bytes for L\U data structures.
+ *           The amount of space used in bytes for L\\U data structures.
  *         - total_needed (float)
  *           The amount of space needed in bytes to perform factorization.
  *         - expansions (int)

diff --git a/SRC/dgsisx.c b/SRC/dgsisx.c
@@ -373,7 +373,7 @@ at the top-level directory.
  * mem_usage (output) mem_usage_t*
  *	   Record the memory usage statistics, consisting of following fields:
  *	   - for_lu (float)
- *	     The amount of space used in bytes for L\U data structures.
+ *	     The amount of space used in bytes for L\\U data structures.
  *	   - total_needed (float)
  *	     The amount of space needed in bytes to perform factorization.
  *	   - expansions (int)

diff --git a/SRC/dgssvx.c b/SRC/dgssvx.c
@@ -324,7 +324,7 @@ at the top-level directory.
  * mem_usage (output) mem_usage_t*
  *         Record the memory usage statistics, consisting of following fields:
  *         - for_lu (float)
- *           The amount of space used in bytes for L\U data structures.
+ *           The amount of space used in bytes for L\\U data structures.
  *         - total_needed (float)
  *           The amount of space needed in bytes to perform factorization.
  *         - expansions (int)

diff --git a/SRC/sgsisx.c b/SRC/sgsisx.c
@@ -373,7 +373,7 @@ at the top-level directory.
  * mem_usage (output) mem_usage_t*
  *	   Record the memory usage statistics, consisting of following fields:
  *	   - for_lu (float)
- *	     The amount of space used in bytes for L\U data structures.
+ *	     The amount of space used in bytes for L\\U data structures.
  *	   - total_needed (float)
  *	     The amount of space needed in bytes to perform factorization.
  *	   - expansions (int)

diff --git a/SRC/sgssvx.c b/SRC/sgssvx.c
@@ -324,7 +324,7 @@ at the top-level directory.
  * mem_usage (output) mem_usage_t*
  *         Record the memory usage statistics, consisting of following fields:
  *         - for_lu (float)
- *           The amount of space used in bytes for L\U data structures.
+ *           The amount of space used in bytes for L\\U data structures.
  *         - total_needed (float)
  *           The amount of space needed in bytes to perform factorization.
  *         - expansions (int)

diff --git a/SRC/slu_cdefs.h b/SRC/slu_cdefs.h
@@ -20,7 +20,7 @@ at the top-level directory.
  * 
  * Global data structures used in LU factorization -
  * 
- *   nsuper: #supernodes = nsuper + 1, numbered [0, nsuper].
+ *   nsuper: \#supernodes = nsuper + 1, numbered [0, nsuper].
  *   (xsup,supno): supno[i] is the supernode no to which i belongs;
  *	xsup(s) points to the beginning of the s-th supernode.
  *	e.g.   supno 0 1 2 2 3 3 3 4 4 4 4 4   (n=12)

diff --git a/SRC/slu_ddefs.h b/SRC/slu_ddefs.h
@@ -20,7 +20,7 @@ at the top-level directory.
  * 
  * Global data structures used in LU factorization -
  * 
- *   nsuper: #supernodes = nsuper + 1, numbered [0, nsuper].
+ *   nsuper: \#supernodes = nsuper + 1, numbered [0, nsuper].
  *   (xsup,supno): supno[i] is the supernode no to which i belongs;
  *	xsup(s) points to the beginning of the s-th supernode.
  *	e.g.   supno 0 1 2 2 3 3 3 4 4 4 4 4   (n=12)

diff --git a/SRC/slu_sdefs.h b/SRC/slu_sdefs.h
@@ -20,7 +20,7 @@ at the top-level directory.
  * 
  * Global data structures used in LU factorization -
  * 
- *   nsuper: #supernodes = nsuper + 1, numbered [0, nsuper].
+ *   nsuper: \#supernodes = nsuper + 1, numbered [0, nsuper].
  *   (xsup,supno): supno[i] is the supernode no to which i belongs;
  *	xsup(s) points to the beginning of the s-th supernode.
  *	e.g.   supno 0 1 2 2 3 3 3 4 4 4 4 4   (n=12)

diff --git a/SRC/slu_zdefs.h b/SRC/slu_zdefs.h
@@ -20,7 +20,7 @@ at the top-level directory.
  * 
  * Global data structures used in LU factorization -
  * 
- *   nsuper: #supernodes = nsuper + 1, numbered [0, nsuper].
+ *   nsuper: \#supernodes = nsuper + 1, numbered [0, nsuper].
  *   (xsup,supno): supno[i] is the supernode no to which i belongs;
  *	xsup(s) points to the beginning of the s-th supernode.
  *	e.g.   supno 0 1 2 2 3 3 3 4 4 4 4 4   (n=12)

diff --git a/SRC/zgsisx.c b/SRC/zgsisx.c
@@ -373,7 +373,7 @@ at the top-level directory.
  * mem_usage (output) mem_usage_t*
  *	   Record the memory usage statistics, consisting of following fields:
  *	   - for_lu (float)
- *	     The amount of space used in bytes for L\U data structures.
+ *	     The amount of space used in bytes for L\\U data structures.
  *	   - total_needed (float)
  *	     The amount of space needed in bytes to perform factorization.
  *	   - expansions (int)

diff --git a/SRC/zgssvx.c b/SRC/zgssvx.c
@@ -324,7 +324,7 @@ at the top-level directory.
  * mem_usage (output) mem_usage_t*
  *         Record the memory usage statistics, consisting of following fields:
  *         - for_lu (float)
- *           The amount of space used in bytes for L\U data structures.
+ *           The amount of space used in bytes for L\\U data structures.
  *         - total_needed (float)
  *           The amount of space needed in bytes to perform factorization.
  *         - expansions (int)