Skip to content

Commit 5c279c1

Browse files
sbryngelsonclaude
andcommitted
Fix Doxygen warnings across docs and Fortran sources (510 → 5)
- Remove filename args from @file directives in all 52 .fpp files - Add @param docs to 13 undocumented subroutines, remove duplicate !< inline comments - Convert raw $...$ math to Doxygen \f$...\f$ in m_riemann_solvers.fpp - Add @cond/@endcond around #ifdef blocks that confuse Doxygen parser - Fix getting-started.md HTML (<h3> in <summary>), contributing.md (@: escaping) - Fix stale @param names in m_data_input.f90 - Remove obsolete Doxyfile tags (HTML_TIMESTAMP, LATEX_TIMESTAMP), fix PROJECT_NAME quoting - Add stable {#id} anchors to generated case_constraints.md and cli-reference.md - Add _escape_doxygen() helper for CLI help text, add missing precheck command - Extend lint_docs.py with math syntax and section anchor checks Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
1 parent 520e679 commit 5c279c1

84 files changed

Lines changed: 5406 additions & 5245 deletions

File tree

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

docs/Doxyfile.in

Lines changed: 2 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -35,7 +35,7 @@ DOXYFILE_ENCODING = UTF-8
3535
# title of most generated pages and in a few other places.
3636
# The default value is: My Project.
3737

38-
PROJECT_NAME = "@DOXYGEN_PROJECT_NAME@"
38+
PROJECT_NAME = @DOXYGEN_PROJECT_NAME@
3939

4040
# The PROJECT_NUMBER tag can be used to enter a project or revision number. This
4141
# could be handy for archiving the generated documentation or if some version
@@ -970,7 +970,7 @@ FILTER_SOURCE_PATTERNS =
970970
# (index.html). This can be useful if you have a project on for instance GitHub
971971
# and want to reuse the introduction page also for the doxygen output.
972972

973-
USE_MDFILE_AS_MAINPAGE = readme.md
973+
USE_MDFILE_AS_MAINPAGE =
974974

975975
#---------------------------------------------------------------------------
976976
# Configuration options related to source browsing
@@ -1205,14 +1205,6 @@ HTML_COLORSTYLE_SAT = 255
12051205

12061206
HTML_COLORSTYLE_GAMMA = 113
12071207

1208-
# If the HTML_TIMESTAMP tag is set to YES then the footer of each generated HTML
1209-
# page will contain the date and time when the page was generated. Setting this
1210-
# to YES can help to show when doxygen was last run and thus if the
1211-
# documentation is up to date.
1212-
# The default value is: NO.
1213-
# This tag requires that the tag GENERATE_HTML is set to YES.
1214-
1215-
HTML_TIMESTAMP = NO
12161208

12171209
# If the HTML_DYNAMIC_MENUS tag is set to YES then the generated HTML
12181210
# documentation will contain a main index with vertical navigation menus that
@@ -1801,13 +1793,6 @@ LATEX_HIDE_INDICES = NO
18011793

18021794
LATEX_BIB_STYLE = plain
18031795

1804-
# If the LATEX_TIMESTAMP tag is set to YES then the footer of each generated
1805-
# page will contain the date and time when the page was generated. Setting this
1806-
# to NO can help when comparing the output of multiple runs.
1807-
# The default value is: NO.
1808-
# This tag requires that the tag GENERATE_LATEX is set to YES.
1809-
1810-
LATEX_TIMESTAMP = NO
18111796

18121797
# The LATEX_EMOJI_DIRECTORY tag is used to specify the (relative or absolute)
18131798
# path from which the emoji images will be read. If a relative path is entered,

docs/documentation/case.md

Lines changed: 47 additions & 47 deletions
Large diffs are not rendered by default.

docs/documentation/contributing.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -148,7 +148,7 @@ Both human reviewers and AI code reviewers reference this section.
148148
### Memory and Allocation
149149

150150
- **ALLOCATE/DEALLOCATE pairing:** Every `@:ALLOCATE()` must have a matching `@:DEALLOCATE()`. Missing deallocations leak GPU memory.
151-
- **@:ACC_SETUP_VFs / @:ACC_SETUP_SFs:** Vector/scalar fields must have GPU pointer setup before use in kernels.
151+
- **`@:ACC_SETUP_VFs` / `@:ACC_SETUP_SFs`:** Vector/scalar fields must have GPU pointer setup before use in kernels.
152152
- **Conditional allocation:** If an array is allocated inside an `if` block, its deallocation must follow the same condition.
153153
- **Out-of-bounds access:** Fortran is permissive with assumed-shape arrays. Check that index arithmetic stays within declared bounds.
154154

docs/documentation/getting-started.md

Lines changed: 5 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -70,7 +70,7 @@ for a Linux experience.
7070

7171
<details>
7272

73-
<summary><h3>Windows + WSL (Recommended)</h3></summary>
73+
<summary><b>Windows + WSL (Recommended)</b></summary>
7474

7575
Install [Windows Subsystem for Linux (WSL)](https://docs.microsoft.com/en-us/windows/wsl/) on Windows 11:
7676
Either
@@ -92,7 +92,7 @@ Once you have WSL installed, you can follow the instructions for *nix systems ab
9292

9393
<details>
9494

95-
<summary><h3>Native Windows (Intel)</h3></summary>
95+
<summary><b>Native Windows (Intel)</b></summary>
9696

9797
Install the latest version of:
9898
- [Microsoft Visual Studio Community](https://visualstudio.microsoft.com/)
@@ -118,7 +118,9 @@ You will also have access to the `.sln` Microsoft Visual Studio solution files f
118118

119119
</details>
120120

121-
<summary><h3>MacOS</h3></summary>
121+
<details>
122+
123+
<summary><b>MacOS</b></summary>
122124

123125
Using [Homebrew](https://brew.sh/) you can install the necessary dependencies
124126
before configuring your environment:

docs/documentation/visualization.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -54,30 +54,30 @@ For analysis and processing of the database using VisIt's capability, the user i
5454
## Serial data output
5555

5656
If ``parallel_io = 'F'``, MFC will output the conservative variables to a directory `D/`.
57-
If multiple cores are used ($\mathtt{ppn > 1}$), then a separate file is created for each core.
57+
If multiple cores are used (\f$\mathtt{ppn > 1}\f$), then a separate file is created for each core.
5858
If only one coordinate dimension (`n = 0` and `p = 0`) exists, the primitive variables will also be written to `D/`.
5959
The file names correspond to the variables associated with each equation solved by MFC.
6060
They are written at every `t_step_save` time step.
6161
The conservative variables are
6262

63-
$$ {(\rho \alpha)}\_{1}, \dots, (\rho\alpha)\_{N\_c}, \rho u\_{1}, \dots, \rho u\_{N\_d}, E, \alpha\_1, \dots, \alpha\_{N\_c} $$
63+
\f[ (\rho \alpha)_{1}, \dots, (\rho\alpha)_{N_c}, \rho u_{1}, \dots, \rho u_{N_d}, E, \alpha_1, \dots, \alpha_{N_c} \f]
6464

6565
and the primitive variables are
6666

67-
$$ {(\rho \alpha)}\_1, \dots, (\rho\alpha)\_{N\_c}, u\_1, \dots, u\_{N\_d}, p, \alpha\_1, \dots, \alpha\_{N\_c} $$
67+
\f[ (\rho \alpha)_1, \dots, (\rho\alpha)_{N_c}, u_1, \dots, u_{N_d}, p, \alpha_1, \dots, \alpha_{N_c} \f]
6868

6969
where $N_c$ are the number of components `num_fluids` and $N_d$ is the number of spatial dimensions.
7070
There are exceptions: if `model_eqns = 3`, then the six-equation model appends these variables with the internal energies of each component.
7171
If there are sub-grid bubbles `bubbles = T`, then the bubble variables are also written.
7272
These depend on the bubble dynamics model used.
7373
If ``polytropic = 'T'``, then the conservative variables are appended by
7474

75-
$$ n\_b R\_1, n\_b {\\dot R}\_1, \dots, n\_b R\_{N\_b}, n\_b {\\dot R}\_{N\_b} $$
75+
\f[ n_b R_1, n_b \dot{R}_1, \dots, n_b R_{N_b}, n_b \dot{R}_{N_b} \f]
7676

7777
where $n_B$ is the bubble number density, and $N_b$ is the number of bubble sizes (see the matching variable in the input file, `Nb`).
7878
The primitive bubble variables do not include $n_B$:
7979

80-
$$ R\_1, {\\dot R}\_1, \dots, R\_{N\_b}, {\\dot R}\_{N\_b} $$
80+
\f[ R_1, \dot{R}_1, \dots, R_{N_b}, \dot{R}_{N_b} \f]
8181

8282
## Remote Visualization on PACE Phoenix
8383

src/common/include/1dHardcodedIC.fpp

Lines changed: 9 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -1,37 +1,37 @@
11
#:def Hardcoded1DVariables()
2-
! Place any declaration of intermediate variables here
2+
! any declaration of intermediate variables here
33
real(wp) :: x_mid_diffu, width_sq, profile_shape, temp, molar_mass_inv, y1, y2, y3, y4
44
#:enddef
55

66
#:def Hardcoded1D()
77
select case (patch_icpp(patch_id)%hcid)
88
case (150) ! 1D Smooth Alfven Case for MHD
9-
! velocity
9+
!
1010
q_prim_vf(momxb + 1)%sf(i, 0, 0) = 0.1_wp*sin(2._wp*pi*x_cc(i))
1111
q_prim_vf(momxb + 2)%sf(i, 0, 0) = 0.1_wp*cos(2._wp*pi*x_cc(i))
1212

13-
! magnetic field
13+
! field
1414
q_prim_vf(B_idx%end - 1)%sf(i, 0, 0) = 0.1_wp*sin(2._wp*pi*x_cc(i))
1515
q_prim_vf(B_idx%end)%sf(i, 0, 0) = 0.1_wp*cos(2._wp*pi*x_cc(i))
1616

1717
case (170)
18-
! This hardcoded case can be used to start a simulation with initial conditions given from a known 1D profile (e.g. Cantera, SDtoolbox)
18+
! hardcoded case can be used to start a simulation with initial conditions given from a known 1D profile (e.g. Cantera, SDtoolbox)
1919
@: HardcodedReadValues()
2020

2121
case (180)
22-
! This is patch is hard-coded for test suite optimization used in the
23-
! 1D_shuoser cases: "patch_icpp(2)%alpha_rho(1)": "1 + 0.2*sin(5*x)"
22+
! is patch is hard-coded for test suite optimization used in the
23+
! cases: "patch_icpp(2)%alpha_rho(1)": "1 + 0.2*sin(5*x)"
2424
if (patch_id == 2) then
2525
q_prim_vf(contxb + 0)%sf(i, 0, 0) = 1 + 0.2*sin(5*x_cc(i))
2626
end if
2727

2828
case (181)
29-
! This is patch is hard-coded for test suite optimization used in the
30-
! 1D_titarevtorro cases: "patch_icpp(2)%alpha_rho(1)": "1 + 0.1*sin(20*x*pi)"
29+
! is patch is hard-coded for test suite optimization used in the
30+
! cases: "patch_icpp(2)%alpha_rho(1)": "1 + 0.1*sin(20*x*pi)"
3131
q_prim_vf(contxb + 0)%sf(i, 0, 0) = 1 + 0.1*sin(20*x_cc(i)*pi)
3232

3333
case (182)
34-
! This patch is a hard-coded for test suite optimization (multiple component diffusion)
34+
! patch is a hard-coded for test suite optimization (multiple component diffusion)
3535
x_mid_diffu = 0.05_wp/2.0_wp
3636
width_sq = (2.5_wp*10.0_wp**(-3.0_wp))**2
3737
profile_shape = 1.0_wp - 0.5_wp*exp(-(x_cc(i) - x_mid_diffu)**2/width_sq)

0 commit comments

Comments
 (0)