Doxygen for MATLAB code

[samcunliffe]

We have MATLAB code which has documentation in the code comments. Make our Doxygen job also read the MATLAB documentation and if necessary, make the functions' docstrings Doxygen-compliant.

Suggestion:

It might seem a bit odd to people that we say TDMS is a hybrid MATLAB and C++ software, yet we don't include the .m files in Doxygen?

I'm not saying we should do this (as .m is also a legacy C format or something right?) but if we're encouraging people to use the MATLAB scripts in the examples we probably should explain how they operate somewhere.

Originally posted by @willGraham01 in #265 (comment)

Ideas

Some easy first links from googling how to do this...

• https://github.com/simgunz/doxymatlab
• https://doxyf.sourceforge.net/doc0/html/mtoc0/

[samcunliffe]

For now, I'll leave it out of the End of ARC project milestone.
We can have it as a stretch goal.

[samcunliffe]

Extra from the Doxygen homepage

MatLab

Ben Heasly has written a filter for doxygen that converts MatLab scripts (including the new object oriented features) into something doxygen can understand. An alternative filter is provided by Ian Martins. There is also one by Fabrice which can be found on Matlab Central.

Looks promising is the second: a tarball from doxygen's downloads page. No license but presumably we can wget it as part of doxygen-gh-pages.yml.

[samcunliffe]

Seems this won't be achieved. By the end of the ARC project. Closing for now.