Update EmittanceInvariants.H

Clean Doxygen
BLAST-ImpactX · Sep 13, 2024 · 6b1e911 · 6b1e911
1 parent b51293b
commit 6b1e911
Showing 1 changed file with 4 additions and 4 deletions.
diff --git a/src/particles/diagnostics/EmittanceInvariants.H b/src/particles/diagnostics/EmittanceInvariants.H
@@ -27,8 +27,8 @@ namespace impactx::diagnostics
      *  under any linear symplectic transport map, and are used in the
      *  calculation of the three eigenemittances.
      *
-     * @param[in] symmetric 6x6 covariance matrix
-     * @returns tuple containing I2, I4, and I6
+     * @param[in] Sigma symmetric 6x6 covariance matrix
+     * @returns tuple containing invariants I2, I4, and I6
      */
     std::tuple<
             amrex::ParticleReal,
@@ -45,8 +45,8 @@ namespace impactx::diagnostics
      *  the projected normalized rms emittances in the limit of
      *  uncoupled transport.
      *
-     * @param[in] symmetric 6x6 covariance matrix
-     * @returns tuple containing e1, e2, and e3
+     * @param[in] Sigma symmetric 6x6 covariance matrix
+     * @returns tuple containing eigenemittances e1, e2, and e3
      */
     std::tuple<
             amrex::ParticleReal,