Feature improve doxygen

[ewanwm]

No description provided.

[codecov-commenter]

⚠️ Please install the to ensure uploads and comments are reliably processed by Codecov.

Codecov Report

All modified and coverable lines are covered by tests ✅

❗ Your organization needs to install the Codecov GitHub app to enable full functionality.

Files	Coverage Δ
nuTens/propagator/const-density-solver.cpp	100.00% <ø> (ø)
nuTens/propagator/const-density-solver.hpp	92.30% <100.00%> (ø)
nuTens/propagator/propagator.cpp	72.22% <ø> (ø)
nuTens/propagator/propagator.hpp	42.85% <ø> (ø)
nuTens/tensors/tensor.hpp	87.50% <ø> (ø)
nuTens/tensors/torch-tensor.cpp	64.19% <ø> (ø)
tests/tensor-basic.cpp	92.98% <ø> (ø)
tests/two-flavour-const-matter.cpp	100.00% <ø> (ø)
tests/two-flavour-vacuum.cpp	100.00% <ø> (ø)

[github-actions]

Cpp-Linter Report ⚠️

Some files did not pass the configured checks!

clang-tidy reports: 2 concern(s)

• nuTens/instrumentation.hpp:168:7: warning: [cppcoreguidelines-special-member-functions]

  class 'InstrumentationTimer' defines a non-default destructor and a copy constructor but does not define a copy assignment operator, a move constructor or a move assignment operator

  class InstrumentationTimer
        ^

• nuTens/propagator/const-density-solver.hpp:83:10: warning: [clang-diagnostic-inconsistent-missing-override]

  'calculateEigenvalues' overrides a member function but is not marked 'override'

      void calculateEigenvalues(const Tensor &energies, Tensor &eigenvectors, Tensor &eigenvalues);
           ^
  /home/runner/work/nuTens/nuTens/nuTens/propagator/base-matter-solver.hpp:20:18: note: overridden virtual function is here
      virtual void calculateEigenvalues(const Tensor &energies, Tensor &eigenvectors, Tensor &eigenvalues) = 0;
                   ^
  /home/runner/work/nuTens/nuTens/nuTens/propagator/const-density-solver.hpp:83:10: warning: annotate this function with 'override' or (rarely) 'final' [cppcoreguidelines-explicit-virtual-functions,modernize-use-override]
      void calculateEigenvalues(const Tensor &energies, Tensor &eigenvectors, Tensor &eigenvalues);
           ^
                                                                                                   override

Have any feedback or feature suggestions? Share it here.

[github-actions]

Cpp-linter Review

No concerns from clang-format.
Only 2 out of 4 clang-tidy concerns fit within this pull request's diff.

Click here for the full clang-tidy patch

diff --git a/nuTens/propagator/const-density-solver.hpp b/nuTens/propagator/const-density-solver.hpp
index 5df83a9..bb411cf 100644
--- a/nuTens/propagator/const-density-solver.hpp
+++ b/nuTens/propagator/const-density-solver.hpp
@@ -83 +83 @@ class ConstDensityMatterSolver : public BaseMatterSolver
-    void calculateEigenvalues(const Tensor &energies, Tensor &eigenvectors, Tensor &eigenvalues);
+    void calculateEigenvalues(const Tensor &energies, Tensor &eigenvectors, Tensor &eigenvalues) override;

Have any feedback or feature suggestions? Share it here.

[github-actions]

clang-tidy diagnostic

nuTens/instrumentation.hpp:168:7: warning: [cppcoreguidelines-special-member-functions]

class 'InstrumentationTimer' defines a non-default destructor and a copy constructor but does not define a copy assignment operator, a move constructor or a move assignment operator

class InstrumentationTimer
      ^

[github-actions]

clang-tidy diagnostic

nuTens/tensors/tensor.hpp:15:7: warning: [bugprone-forward-declaration-namespace]

no definition found for 'Tensor', but a definition with the same name 'Tensor' found in another namespace '(global)'

class Tensor;
      ^
/home/runner/work/nuTens/nuTens/nuTens/tensors/tensor.hpp:21:7: note: a definition of 'Tensor' is found here
class Tensor
      ^