Automatic documentation of an OO MATLAB project with mtoc++/Doxygen

Question

I have an OO project in MATLAB and would like to automatically produce some documentation.

After some research I have found a convenient tool called mtoc++ which apparently produces a documentation using Doxygen (I have no experience with).

My only question is whether in order to use the tool I need to write comments in MATLAB using a specific format (language?) so that mtoc++/Doxygen could understand and document my comments?

If so, then what this format/ language is and where I can find its description?

Answer 1

After correctly installing and configuring mtoc++/Doxygen, the documentation is created automatically.

If you want to define personalized comments for specific custom parameters, you can follow the instructions on this page:

http://www.ians.uni-stuttgart.de/MoRePaS/software/mtocpp/docs/tools.html

Look under the heading Configuration options for the mtoc++ filter.

What you have to do is to edit the mtocpp.conf file, located in tools/config folder, and the format you'll be using is this:

add(params) = <parameter1_name> => """Your parameter1 description text in triple quotes""";

An example would be:

add(params) = myVariable => """This variable is defined by me""";

So you can define personalized comments for your Parameters, Fields, Extra Documentation and Global Settings.

I am sure there must be other workarounds to add comments and documentation.

I hope this helps. Happy coding.