Apply suggestions from code review

Co-authored-by: Sam Cunliffe <[email protected]>
UCL · Jun 5, 2023 · 4a3a1fb · 4a3a1fb
1 parent bd713f8
commit 4a3a1fb
Show file tree

Hide file tree

Showing 2 changed files with 11 additions and 11 deletions.
diff --git a/tdms/include/arrays/tdms_matrix.h b/tdms/include/arrays/tdms_matrix.h
@@ -13,8 +13,8 @@
  *
  * this->(i, j) = data_[i * n_cols_ + j].
  *
- * This is consistent with the way hdf5 files store array-like data, see
- * https://support.hdfgroup.org/HDF5/doc1.6/UG/12_Dataspaces.html.
+ * @seealso This is consistent with the way hdf5 files store array-like data, see
+ *          https://support.hdfgroup.org/HDF5/doc1.6/UG/12_Dataspaces.html.
  * @tparam T Numerical datatype
  */
 template<typename T>
@@ -91,11 +91,11 @@ typedef Matrix<double> CCoefficientMatrix;
 
 /**
  * @brief Defines the numerical aperture of the objective, assuming that the
- * lens is centred on the origin of the PSTD simulation.
+ *        lens is centred on the origin of the PSTD simulation.
  * @details In particular, since the fibre modes are imaged onto a Fourier plane
- * of both the physical fibre and the sample, the field scattered by the sample
- * and collected by the objective lens can have only a finite spatial support in
- * the aperture of the objective lens.
+ *         of both the physical fibre and the sample, the field scattered by the sample
+ *         and collected by the objective lens can have only a finite spatial support in
+ *         the aperture of the objective lens.
  *
  * Pupil(i, j) thus takes the value 1 for those (i,j) indices within the
  * aperture of the lens.

diff --git a/tdms/include/simulation_manager/objects_from_infile.h b/tdms/include/simulation_manager/objects_from_infile.h
@@ -65,12 +65,12 @@ class IndependentObjectsFromInfile {
 
   IncidentField Ei;//< time-domain field
 
-  FrequencyVectors f_vec;//<! Frequency vector
-  Pupil pupil;           //<! Numerical aperture of the objective lens
-  DTilde D_tilde;        //< TODO
-  TDFieldExporter2D ex_td_field_exporter;//< two-dimensional field exporter
+  FrequencyVectors f_vec;//!< Frequency vector
+  Pupil pupil;           //!< Numerical aperture of the objective lens
+  DTilde D_tilde;        //!< TODO
+  TDFieldExporter2D ex_td_field_exporter;//!< two-dimensional field exporter
 
-  GridLabels input_grid_labels;//< cartesian labels of the Yee cells
+  GridLabels input_grid_labels;//!< cartesian labels of the Yee cells
 
   /* DERIVED VARIABLES FROM INDEPENDENT INPUTS */