Updated doc about page names

docs/doxygen/contents/README.md

@@ -2,6 +2,4 @@
 
 We shall follow the official Doxygen examples that can be found [here](https://github.com/doxygen/doxygen/tree/master/doc). In addition, check the result pages [here](http://www.stack.nl/~dimitri/doxygen/manual/index.html).
 
-**To enforce the order of customized pages, we need to explicitly add the page files under [INPUT](https://bitbucket.org/numgeom/psmilu/src/f1eac4817f2f79e9a2f0d4830de3238071f175c3/docs/doxygen/Doxyfile.cfg?at=master&fileviewer=file-view-default#Doxyfile.cfg-794) with the preferred order.**
-
-The reference symbol should starts with "_" (like what we do for protected/private member fields).
+**To enforce the order of customized pages, we need to explicitly add the page files under `INPUT` in file `Doxyfile.cfg` with the preferred order.**

docs/doxygen/contents/examples.doc

@@ -5,25 +5,25 @@
 //----------------------------------------------------------------------------
 //@HEADER
 
-/*! \page _examples Collection of Examples
+/*! \page eg_page Collection of Examples
 
 \addindex examples
 \tableofcontents
 
-\section _eg_beginner Beginner
+\section eg_beginner Beginner
 
 - \ref demo_simple.cpp
 - \ref demo_trans.cpp
 - \ref demo_verbose.cpp
 
-\section _eg_intermediate Intermediate
+\section eg_intermediate Intermediate
 
 - \ref demo_params.cpp
 - \ref demo_multiply.cpp
 - \ref demo_mixedprecision.cpp
 - \ref demo_complex.cpp
 
-\section _eg_advanced Advanced
+\section eg_advanced Advanced
 
 - \ref demo_hifir.cpp
 - \ref demo_gmreshif.cpp

docs/doxygen/contents/install.doc

@@ -5,12 +5,12 @@
 //----------------------------------------------------------------------------
 //@HEADER
 
-/*! \page _install Installation
+/*! \page install Installation
 
 \addindex installation
 \tableofcontents
 
-\section _install_cpp Installation of the C++ interface
+\section install_cpp Installation of the C++ interface
 
 The *HIFIR* package is written in C++, and it uses template-based and
 header-only programming. Hence, the installation of C++ interface is pretty
@@ -43,7 +43,7 @@ or copy the source files to any user-level directories, e.g.,
 
 and then add `-I$HOME/.local/include` to the command line of your C++ compiler.
 
-\section _install_c Installation of the C library (libhifir)
+\section install_c Installation of the C library (libhifir)
 
 Finish me...
 

docs/doxygen/contents/params.doc

@@ -5,7 +5,7 @@
 //----------------------------------------------------------------------------
 //@HEADER
 
-/*! \page _params Control Parameters
+/*! \page params Control Parameters
 
 \addindex parameters
 \tableofcontents
@@ -27,7 +27,7 @@ The instance \a params is a C++ structure whose fields are different control
 parameters for computing HIF preconditioners. In the following, we will address
 commonly-used parameters categorized in different groups.
 
-\section _params_basic Essential Parameters
+\section params_basic Essential Parameters
 
 We summary several essential control parameters used in HIF.
 
@@ -64,7 +64,7 @@ following settings
     params.dense_thres = 500;
 \endcode
 
-\section _params_system System Parameters
+\section params_system System Parameters
 
 - \ref hif::Params::verbose controls the verbose levels during factorizations.
   By default, \ref hif::VERBOSE_INFO is enabled. A new level can be enabled via
@@ -76,7 +76,7 @@ following settings
   system via envrionment variable `OMP_NUM_THREADS` or function
   `omp_get_max_threads`.
 
-\section _params_adv Advanced Parameters
+\section params_adv Advanced Parameters
 
 In this section, we address some advanced parameters, which may become useful.
 
@@ -92,7 +92,7 @@ In this section, we address some advanced parameters, which may become useful.
   To enforce using or disable rook pivoting, use \ref hif::PIVOTING_ON and
   \ref hif::PIVOTING_OFF, respectively.
 
-\section _params_pre Preprocessing Parameters
+\section params_pre Preprocessing Parameters
 
 - \ref hif::Params::reorder is for choosing different fill-reduction reordering
   schemes, and we use AMD (\ref hif::REORDER_AMD) by default for its robustness.