Skip to content

Commit 55da357

Browse files
sbryngelsonclaude
andcommitted
Fix 472 of 477 Doxygen @param warnings and add WARN_LOGFILE
- Add DOXYGEN_WARN_LOGFILE to CMakeLists.txt and Doxyfile.in to capture per-target warning logs during documentation builds - Fix stale, missing, duplicate, and misspelled @param entries across 28 source files (common, pre_process, post_process, simulation modules) - Common module fixes (m_helper, m_model, m_mpi_common, m_phase_change, m_finite_differences) eliminate 3x warnings since each is shared across all three Doxygen targets - Remaining 5 warnings are structural unbalanced grouping from fypp macro expansion, not @param issues Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
1 parent 3c5dc26 commit 55da357

44 files changed

Lines changed: 227 additions & 129 deletions

Some content is hidden

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

CMakeLists.txt

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -727,6 +727,8 @@ if (MFC_DOCUMENTATION)
727727
set(DOXYGEN_IMAGE_PATH "\"${CMAKE_CURRENT_SOURCE_DIR}/docs/res\"\
728728
\"${CMAKE_CURRENT_SOURCE_DIR}/docs/${target}\"")
729729

730+
set(DOXYGEN_WARN_LOGFILE "\"${CMAKE_CURRENT_BINARY_DIR}/${target}-doxygen-warnings.log\"")
731+
730732
file(MAKE_DIRECTORY "${DOXYGEN_OUTPUT_DIRECTORY}")
731733

732734
configure_file(

docs/Doxyfile.in

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -806,7 +806,7 @@ WARN_FORMAT = "$file:$line: $text"
806806
# messages should be written. If left blank the output is written to standard
807807
# error (stderr).
808808

809-
WARN_LOGFILE =
809+
WARN_LOGFILE = @DOXYGEN_WARN_LOGFILE@
810810

811811
#---------------------------------------------------------------------------
812812
# Configuration options related to the input files

docs/documentation/authors.md

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -3,3 +3,6 @@
33
## Authors
44

55
Contributors to MFC since 2019 can be [viewed here](https://github.com/MFlowCode/MFC/graphs/contributors).
6+
7+
8+
<div style='text-align:center; font-size:0.75rem; color:#888; padding:16px 0 0;'>Page last updated: 2026-02-04</div>

docs/documentation/case.md

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1202,3 +1202,6 @@ The above variables are used for all simulations.
12021202
| hypoelastic variables | N/A |
12031203

12041204
The above variables correspond to optional physics.
1205+
1206+
1207+
<div style='text-align:center; font-size:0.75rem; color:#888; padding:16px 0 0;'>Page last updated: 2026-02-15</div>

docs/documentation/contributing.md

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -767,3 +767,6 @@ If your change touches GPU code (`src/simulation/`), see the GPU checklist in th
767767
- A maintainer will merge your PR once all reviews are approved and CI is green
768768

769769
If your PR is large or architectural, consider opening an issue first to discuss the approach.
770+
771+
772+
<div style='text-align:center; font-size:0.75rem; color:#888; padding:16px 0 0;'>Page last updated: 2026-02-15</div>

docs/documentation/docker.md

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -188,3 +188,6 @@ linux/loong64
188188
linux/arm/v7
189189
linux/arm/v6
190190
```
191+
192+
193+
<div style='text-align:center; font-size:0.75rem; color:#888; padding:16px 0 0;'>Page last updated: 2026-02-04</div>

docs/documentation/equations.md

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1049,3 +1049,6 @@ Additionally, the **artificial Mach number** technique (`pi_fac`) modifies \f$\p
10491049

10501050
**Advective flux limiting** based on local volume fraction gradient \f$\chi\f$ to prevent spurious oscillations near material interfaces.
10511051

1052+
1053+
1054+
<div style='text-align:center; font-size:0.75rem; color:#888; padding:16px 0 0;'>Page last updated: 2026-02-15</div>

docs/documentation/expectedPerformance.md

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -208,3 +208,6 @@ The "base case" uses 2M and 8M grid points per process.
208208
CPU strong scaling tests are done with problem sizes of 16, 32, and 64M grid points, with the base case using 2, 4, and 8M cells per process.
209209

210210
<img src="../res/strongScaling/cpuStrongScaling.svg" style="width: 50%; border-radius: 10pt"/>
211+
212+
213+
<div style='text-align:center; font-size:0.75rem; color:#888; padding:16px 0 0;'>Page last updated: 2026-02-16</div>

docs/documentation/getting-started.md

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -241,3 +241,6 @@ autoload -Uz compinit && compinit
241241
```
242242

243243
After reloading your shell, press Tab to complete commands and options.
244+
245+
246+
<div style='text-align:center; font-size:0.75rem; color:#888; padding:16px 0 0;'>Page last updated: 2026-02-15</div>

docs/documentation/gpuParallelization.md

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -779,3 +779,6 @@ LIBOMPTARGET_JIT_SKIP_OPT=1
779779
- NVHPC is built on top of LLVM
780780
- [OpenMP Docs](https://www.openmp.org/spec-html/5.1/openmp.html)
781781
- [OpenACC Docs](https://www.openacc.org/sites/default/files/inline-files/OpenACC.2.7.pdf)
782+
783+
784+
<div style='text-align:center; font-size:0.75rem; color:#888; padding:16px 0 0;'>Page last updated: 2026-02-04</div>

0 commit comments

Comments
 (0)