Skip to content

Commit bf2b25f

Browse files
sbryngelsonclaude
andcommitted
Add module-level @brief descriptions for all 16 undocumented modules
Doxygen uses the comment block directly before the module declaration (not the @file header) to populate the Modules List page. These 16 modules only had file-level @Briefs, so they appeared with empty descriptions on the namespace list pages. Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
1 parent 609ea97 commit bf2b25f

16 files changed

Lines changed: 17 additions & 0 deletions

src/common/m_chemistry.fpp

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -6,6 +6,7 @@
66
#:include 'macros.fpp'
77
#:include 'case.fpp'
88

9+
!> @brief Multi-species chemistry interface for thermodynamic properties, reaction rates, and transport coefficients
910
module m_chemistry
1011

1112
use m_thermochem, only: &

src/common/m_constants.fpp

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,7 @@
22
!! @file
33
!! @brief Contains constant values used throughout the code(s).
44

5+
!> @brief Compile-time constant parameters: default values, tolerances, and physical constants
56
module m_constants
67

78
use m_precision_select

src/common/m_delay_file_access.f90

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,7 @@
22
!! @file
33
!! @brief Contains module m_delay_file_access
44

5+
!> @brief Rank-staggered file access delays to prevent I/O contention on parallel file systems
56
module m_delay_file_access
67
use m_precision_select
78
implicit none

src/common/m_finite_differences.fpp

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,7 @@
44

55
#:include 'macros.fpp'
66

7+
!> @brief Finite difference operators for computing divergence of velocity fields
78
module m_finite_differences
89

910
use m_global_parameters

src/common/m_helper.fpp

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -5,6 +5,7 @@
55
!! @file
66
!! @brief Contains module m_helper
77

8+
!> @brief Utility routines for bubble model setup, coordinate transforms, array sampling, and special functions
89
module m_helper
910

1011
use m_derived_types !< Definitions of the derived types

src/common/m_helper_basic.fpp

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,7 @@
44

55
#:include 'macros.fpp'
66

7+
!> @brief Basic floating-point utilities: approximate equality, default detection, and coordinate bounds
78
module m_helper_basic
89

910
use m_derived_types !< Definitions of the derived types

src/common/m_model.fpp

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -5,6 +5,7 @@
55

66
#:include 'macros.fpp'
77

8+
!> @brief Binary STL file reader and processor for immersed boundary geometry
89
module m_model
910

1011
use m_helper

src/common/m_nvtx.f90

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,7 @@
22
!! @file
33
!! @brief Contains module m_nvtx
44

5+
!> @brief NVIDIA NVTX profiling API bindings for GPU performance instrumentation
56
module m_nvtx
67

78
use iso_c_binding

src/common/m_phase_change.fpp

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -5,6 +5,7 @@
55
#:include 'case.fpp'
66
#:include 'macros.fpp'
77

8+
!> @brief Phase transition relaxation solvers for liquid-vapor flows with cavitation and boiling
89
module m_phase_change
910

1011
#ifndef MFC_POST_PROCESS

src/pre_process/m_assign_variables.fpp

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -5,6 +5,7 @@
55
#:include 'case.fpp'
66
#:include 'macros.fpp'
77

8+
!> @brief Assigns initial primitive variables to computational cells based on patch geometry
89
module m_assign_variables
910

1011
use m_derived_types ! Definitions of the derived types

0 commit comments

Comments
 (0)