Doxygen Documentation
Add a doc folder like in SOFI
The Doxyfile can be inspired by the SOFI Doxyfile. All classes in IFOS need to be checked for existing or correct doxygen comments.
Checklist:
-
Gradient -
IFOS.cpp -
Optimization -
GradientCalculation -
StepLengthSearch -
ZeroLagCrossCorrelation
A pdf guide can be prepared: we can reuse the SOFI guide here. The theory part can be striped. Parts like the input parameter description and the code requirements can be reused but may need to be slightly changed and extended with IDFOS parameters.
-
pdf guide