Skip to content

Commit 33cf9bc

Browse files
sbryngelsonclaude
andcommitted
Add missing @file documentation blocks to 16 source files
Add Doxygen @file/@brief blocks to 13 modules that were missing them (m_body_forces, m_igr, m_muscl, m_sim_helpers, m_surface_tension, m_finite_differences, m_mpi_common, m_nvtx, m_delay_file_access, m_phase_change, m_check_ib_patches, m_check_patches, m_simplex_noise) and fix 3 files with malformed comment openers (m_chemistry used !!> instead of !>, m_data_output and m_helper_basic started with !! continuation markers instead of !> openers). All file list pages now show descriptions for every entry. Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
1 parent 98b8351 commit 33cf9bc

16 files changed

Lines changed: 56 additions & 5 deletions

src/common/m_chemistry.fpp

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
1-
!!>
1+
!>
22
!! @file
3-
!! @brief Contains module m_chemistry
3+
!! @brief Contains module m_chemistry
44
!! @author Henry Le Berre <hberre3@gatech.edu>
55

66
#:include 'macros.fpp'

src/common/m_delay_file_access.f90

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,7 @@
1+
!>
2+
!! @file
3+
!! @brief Contains module m_delay_file_access
4+
15
module m_delay_file_access
26
use m_precision_select
37
implicit none

src/common/m_finite_differences.fpp

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,7 @@
1+
!>
2+
!! @file
3+
!! @brief Contains module m_finite_differences
4+
15
#:include 'macros.fpp'
26

37
module m_finite_differences

src/common/m_helper_basic.fpp

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
1+
!>
22
!! @file
33
!! @brief Contains module m_helper_basic
44

src/common/m_mpi_common.fpp

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,7 @@
1+
!>
2+
!! @file
3+
!! @brief Contains module m_mpi_common
4+
15
#:include 'case.fpp'
26
#:include 'macros.fpp'
37

src/common/m_nvtx.f90

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,7 @@
1+
!>
2+
!! @file
3+
!! @brief Contains module m_nvtx
4+
15
module m_nvtx
26

37
use iso_c_binding

src/common/m_phase_change.fpp

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,7 @@
1-
!> energies (6-eqn to 4-eqn) equilibrium through an infinitely fast (algebraic)
2-
!> procedure.
1+
!>
2+
!! @file
3+
!! @brief Contains module m_phase_change
4+
35
#:include 'case.fpp'
46
#:include 'macros.fpp'
57

src/pre_process/m_check_ib_patches.fpp

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,7 @@
1+
!>
2+
!! @file
3+
!! @brief Contains module m_check_ib_patches
4+
15
!> @brief This module contains subroutines that read, and check consistency
26
!! of, the user provided inputs and data.
37

src/pre_process/m_check_patches.fpp

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,7 @@
1+
!>
2+
!! @file
3+
!! @brief Contains module m_check_patches
4+
15
#:include 'macros.fpp'
26

37
!> @brief This module contains subroutines that read, and check consistency

src/pre_process/m_simplex_noise.fpp

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,7 @@
1+
!>
2+
!! @file
3+
!! @brief Contains module m_simplex_noise
4+
15
module m_simplex_noise
26

37
use m_constants

0 commit comments

Comments
 (0)