Skip to content

Commit a028214

Browse files
committed
Updated doc about page names
1 parent 522381f commit a028214

File tree

4 files changed

+13
-15
lines changed

4 files changed

+13
-15
lines changed

docs/doxygen/contents/README.md

Lines changed: 1 addition & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,4 @@
22

33
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).
44

5-
**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.**
6-
7-
The reference symbol should starts with "_" (like what we do for protected/private member fields).
5+
**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

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -5,25 +5,25 @@
55
//----------------------------------------------------------------------------
66
//@HEADER
77

8-
/*! \page _examples Collection of Examples
8+
/*! \page eg_page Collection of Examples
99
1010
\addindex examples
1111
\tableofcontents
1212
13-
\section _eg_beginner Beginner
13+
\section eg_beginner Beginner
1414
1515
- \ref demo_simple.cpp
1616
- \ref demo_trans.cpp
1717
- \ref demo_verbose.cpp
1818
19-
\section _eg_intermediate Intermediate
19+
\section eg_intermediate Intermediate
2020
2121
- \ref demo_params.cpp
2222
- \ref demo_multiply.cpp
2323
- \ref demo_mixedprecision.cpp
2424
- \ref demo_complex.cpp
2525
26-
\section _eg_advanced Advanced
26+
\section eg_advanced Advanced
2727
2828
- \ref demo_hifir.cpp
2929
- \ref demo_gmreshif.cpp

docs/doxygen/contents/install.doc

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -5,12 +5,12 @@
55
//----------------------------------------------------------------------------
66
//@HEADER
77

8-
/*! \page _install Installation
8+
/*! \page install Installation
99
1010
\addindex installation
1111
\tableofcontents
1212
13-
\section _install_cpp Installation of the C++ interface
13+
\section install_cpp Installation of the C++ interface
1414
1515
The *HIFIR* package is written in C++, and it uses template-based and
1616
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.,
4343
4444
and then add `-I$HOME/.local/include` to the command line of your C++ compiler.
4545
46-
\section _install_c Installation of the C library (libhifir)
46+
\section install_c Installation of the C library (libhifir)
4747
4848
Finish me...
4949

docs/doxygen/contents/params.doc

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@
55
//----------------------------------------------------------------------------
66
//@HEADER
77

8-
/*! \page _params Control Parameters
8+
/*! \page params Control Parameters
99
1010
\addindex parameters
1111
\tableofcontents
@@ -27,7 +27,7 @@ The instance \a params is a C++ structure whose fields are different control
2727
parameters for computing HIF preconditioners. In the following, we will address
2828
commonly-used parameters categorized in different groups.
2929
30-
\section _params_basic Essential Parameters
30+
\section params_basic Essential Parameters
3131
3232
We summary several essential control parameters used in HIF.
3333
@@ -64,7 +64,7 @@ following settings
6464
params.dense_thres = 500;
6565
\endcode
6666
67-
\section _params_system System Parameters
67+
\section params_system System Parameters
6868
6969
- \ref hif::Params::verbose controls the verbose levels during factorizations.
7070
By default, \ref hif::VERBOSE_INFO is enabled. A new level can be enabled via
@@ -76,7 +76,7 @@ following settings
7676
system via envrionment variable `OMP_NUM_THREADS` or function
7777
`omp_get_max_threads`.
7878
79-
\section _params_adv Advanced Parameters
79+
\section params_adv Advanced Parameters
8080
8181
In this section, we address some advanced parameters, which may become useful.
8282
@@ -92,7 +92,7 @@ In this section, we address some advanced parameters, which may become useful.
9292
To enforce using or disable rook pivoting, use \ref hif::PIVOTING_ON and
9393
\ref hif::PIVOTING_OFF, respectively.
9494
95-
\section _params_pre Preprocessing Parameters
95+
\section params_pre Preprocessing Parameters
9696
9797
- \ref hif::Params::reorder is for choosing different fill-reduction reordering
9898
schemes, and we use AMD (\ref hif::REORDER_AMD) by default for its robustness.

0 commit comments

Comments
 (0)