Refactor class documentation

[rath3t]

No description provided.

[codecov]

Codecov Report

Attention: 84 lines in your changes are missing coverage. Please review.

Comparison is base (1c8e1be) 91.32% compared to head (04337f5) 82.42%.
Report is 1 commits behind head on main.

Files	Patch %	Lines
ikarus/controlroutines/pathfollowing.inl	0.00%	32 Missing ⚠️
ikarus/utils/observer/observer.hh	43.33%	17 Missing ⚠️
ikarus/controlroutines/pathfollowingfunctions.hh	0.00%	7 Missing ⚠️
ikarus/controlroutines/pathfollowing.hh	0.00%	6 Missing ⚠️
...olver/newtonraphsonwithscalarsubsidiaryfunction.hh	0.00%	5 Missing ⚠️
ikarus/controlroutines/adaptivestepsizing.hh	0.00%	3 Missing ⚠️
ikarus/solver/nonlinearsolver/trustregion.hh	89.28%	3 Missing ⚠️
ikarus/utils/observer/controllogger.hh	0.00%	3 Missing ⚠️
ikarus/finiteelements/ferequirements.hh	86.66%	2 Missing ⚠️
ikarus/io/resultfunction.hh	0.00%	2 Missing ⚠️
... and 2 more

Additional details and impacted files

@@            Coverage Diff             @@
##             main     #220      +/-   ##
==========================================
- Coverage   91.32%   82.42%   -8.90%     
==========================================
  Files          45       47       +2     
  Lines        1879     1855      -24     
==========================================
- Hits         1716     1529     -187     
- Misses        163      326     +163     

Flag	Coverage Δ
tests	82.42% <69.67%> (-8.90%)	⬇️

Flags with carried forward coverage won't be shown. Click here to find out more.

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

[rath3t]

@tarun-mitruka Since, your last PR adds a heavy test which takes very long the coverage went done, since it is not tested anymore. Now Coverage only uses cpp_quick Ctest label. Can you write proper faster tests, i.e. some unit tests? Thanks!

[tarun-mitruka]

@tarun-mitruka Since, your last PR adds a heavy test which takes very long the coverage went done, since it is not tested anymore. Now Coverage only uses cpp_quick Ctest label. Can you write proper faster tests, i.e. some unit tests? Thanks!

Sure. Can you open a new issue for it? Else, it might get lost in the comments. Perhaps after #88, testadaptivestepsizing.cpp can be moved to cpp_quick, probably with some refactoring.