Which tool are you using to create the documentation of your MATLAB codes?

I would like to know which documentation system you use to create the developer's guide or your MATLAB codes.

I already found 2 FEx utilities on this subject:

makehtmldoc to create easily HTML help pages from MATLAB codes.

Using Doxygen with Matlab

I plan to try Doxygen which seems popular . Have you already tried it?

Do you know other tools which can extract comments from your codes to generate documentation?

Thanks for your feedback

Answer 1

[per isakson]

M2HTML: Documentation System for Matlab in HTML has been around and supported for a long time - long before the new OOP-system. It is definitely worth looking at.

The questions says that the documentation support of Matlab is not adequate for your needs.

[Aurelien Queffurust]

I am going to try it thanks

[Aurelien Queffurust]

I have tried files from Fex which use Doxygen but it requires a lot of stuff to install and some time to understand the mechanism. My favorite one will be M2HTML which is both easy and quick to run . The output is very nice if the source code has a M-file header . Nice features a with Graph, each HTML output file gives dependencies, parent functions ... Super! Thanks for your suggestion.

Answer 2

[Mark Mikofski]

Try Sphinx MATLAB domain, it's free and it automatically generates documents from your H1 comments if they are formatted using Sphinx markup. Disclaimer, I was the original author of the Sphinx MATLAB domain.

[Brian Holmes]

The Sphinx MATLAB seems to be a promising choice. But its documentation and help is very poor, making it effectively useless.

[Nathan Ellingson]

After reweiwing all the tools under this question, I settled on this one. Sphinx Matlab is a plugin to Sphinx so some Sphinx knowledge is required to use it. I found that the Sphinx Matlab documentation was excellent, while the Sphinx proper documentation was kind of hard to folow. However, I think this is expected with a project as complex and powerful as Sphinx.

If you have time to work with sphinx to make some really excellent custom documentation, I recommend using the Matlab plugin for sphinx. If you need documentation right now and don't have time to mess with it I recommend m2html (I think the brain template looks the best).

Answer 3

[Pierre Ollfisch]

You could also try m2docgen. It generates HTML-websites based on your header comments and integrates them directly in the local MATLAB documentation. It works with '*.m' and '*.mlx' files of functions, classes and scripts. The sites can also be found by the search function, as the builddocsearchdb is also called in the process. I have attached an example of how the input and output looks for a class file.

Input:

Output:

Disclaimer: I am a developer of m2doc.

Answer 4

[Ryan G]

MATLAB Report Generator has a lot of options for HTML reports. It's not free, but obviously it's designed well for the job.

[Jiri Vass]

Can you please provide more details about using the MATLAB Report Generator for automatically generating the documentation of my Matlab code? I used the M2HTML already and it generates useful Matlab code documentation (e.g. dependency diagram, HTML to browse my functions), but if the MATLAB Report Generator provides even better functionality, I'd like to know about it.

Answer 5

[Sean de Wolski]

Also, an (impossible to remember) function:

builddocsearchdb

[Aurelien Queffurust]

I am using this function to make the help of functions of my own toolbox reachable from Help browser. It is the only aim of this feature I believe , it will not create HTML files from your code.

[Sean de Wolski]

No - it won't do that. But publish() would...