Make comments in header files Doxygen-readable

4 files changed, 19 insertions, 11 deletions

diff --git a/Source/FieldSolver/SpectralSolver/SpectralAlgorithms/PsatdAlgorithm.H b/Source/FieldSolver/SpectralSolver/SpectralAlgorithms/PsatdAlgorithm.H
index bc7f90fac..b7aed9e40 100644
--- a/Source/FieldSolver/SpectralSolver/SpectralAlgorithms/PsatdAlgorithm.H
+++ b/Source/FieldSolver/SpectralSolver/SpectralAlgorithms/PsatdAlgorithm.H
@@ -3,7 +3,8 @@
 
 #include <SpectralBaseAlgorithm.H>
 
-/* \brief Class that updates the field in spectral space
+/**
+ * \brief Class that updates the field in spectral space
  * and stores the coefficients of the corresponding update equation.
  */
 class PsatdAlgorithm : public SpectralBaseAlgorithm
diff --git a/Source/FieldSolver/SpectralSolver/SpectralFieldData.H b/Source/FieldSolver/SpectralSolver/SpectralFieldData.H
index 01ca11083..dc83d279d 100644
--- a/Source/FieldSolver/SpectralSolver/SpectralFieldData.H
+++ b/Source/FieldSolver/SpectralSolver/SpectralFieldData.H
@@ -8,20 +8,20 @@
 // Declare type for spectral fields
 using SpectralField = amrex::FabArray< amrex::BaseFab <Complex> >;
 
-/* Index for the regular fields, when stored in spectral space */
+/** Index for the regular fields, when stored in spectral space */
 struct SpectralFieldIndex {
   enum { Ex=0, Ey, Ez, Bx, By, Bz, Jx, Jy, Jz, rho_old, rho_new, n_fields };
   // n_fields is automatically the total number of fields
 };
 
-/* Index for the PML fields, when stored in spectral space */
+/** Index for the PML fields, when stored in spectral space */
 struct SpectralPMLIndex {
   enum { Exy=0, Exz, Eyx, Eyz, Ezx, Ezy,
            Bxy, Bxz, Byx, Byz, Bzx, Bzy, n_fields };
   // n_fields is automatically the total number of fields
 };
 
-/* \brief Class that stores the fields in spectral space, and performs the
+/** \brief Class that stores the fields in spectral space, and performs the
  *  Fourier transforms between real space and spectral space
  */
 class SpectralFieldData
diff --git a/Source/FieldSolver/SpectralSolver/SpectralKSpace.H b/Source/FieldSolver/SpectralSolver/SpectralKSpace.H
index a73356dca..eb07e8fe6 100644
--- a/Source/FieldSolver/SpectralSolver/SpectralKSpace.H
+++ b/Source/FieldSolver/SpectralSolver/SpectralKSpace.H
@@ -19,7 +19,8 @@ struct ShiftType {
     enum{ TransformFromCellCentered=0, TransformToCellCentered=1 };
 };
 
-/* \brief Class that represents the spectral space.
+/**
+ * \brief Class that represents the spectral space.
  *
  * (Contains info about the size of the spectral space corresponding
  * to each box in `realspace_ba`, as well as the value of the
diff --git a/Source/FieldSolver/SpectralSolver/SpectralSolver.H b/Source/FieldSolver/SpectralSolver/SpectralSolver.H
index c570b017b..1506f4c23 100644
--- a/Source/FieldSolver/SpectralSolver/SpectralSolver.H
+++ b/Source/FieldSolver/SpectralSolver/SpectralSolver.H
@@ -4,7 +4,8 @@
 #include <SpectralBaseAlgorithm.H>
 #include <SpectralFieldData.H>
 
-/* \brief Top-level class for the electromagnetic spectral solver
+/**
+ * \brief Top-level class for the electromagnetic spectral solver
  *
  * Stores the field in spectral space, and has member functions
  * to Fourier-transform the fields between real space and spectral space
@@ -26,18 +27,21 @@ class SpectralSolver
                         const amrex::RealVect dx, const amrex::Real dt,
                         const bool pml=false );
 
-        /* \brief Transform the component `i_comp` of MultiFab `mf`
+        /**
+         * \brief Transform the component `i_comp` of MultiFab `mf`
          *  to spectral space, and store the corresponding result internally
          *  (in the spectral field specified by `field_index`) */
-        void ForwardTransform( const amrex::MultiFab& mf,
+         void ForwardTransform( const amrex::MultiFab& mf,
                                const int field_index,
                                const int i_comp=0 ){
             BL_PROFILE("SpectralSolver::ForwardTransform");
             field_data.ForwardTransform( mf, field_index, i_comp );
         };
 
-        /* \brief Transform spectral field specified by `field_index` back to
-         * real space, and store it in the component `i_comp` of `mf` */
+        /**
+         * \brief Transform spectral field specified by `field_index` back to
+         * real space, and store it in the component `i_comp` of `mf`
+         */
         void BackwardTransform( amrex::MultiFab& mf,
                                 const int field_index,
                                 const int i_comp=0 ){
@@ -45,7 +49,9 @@ class SpectralSolver
             field_data.BackwardTransform( mf, field_index, i_comp );
         };
 
-        /* \brief Update the fields in spectral space, over one timestep */
+        /**
+         * \brief Update the fields in spectral space, over one timestep
+         */
         void pushSpectralFields(){
             BL_PROFILE("SpectralSolver::pushSpectralFields");
             // Virtual function: the actual function used here depends