Are there any tools for generating developer documentation of Simulink model

Hi,

I am deveoping a project in Simulink and also use Stateflow. I want to have an auto generated documentation either from the simulink models or from the generated code using "code generation toolbox". I have verified some sources like sphinx for matlab, but I am confused as it is only applicable for .m files. My code generated would be in c++.

Can anyone suggest something? (I am already thinking of tools like doxygen and sphinx. Please exclude report generator)

Thanks in advance.

Answer 1

[Karanjot]

Hi Harish,

To generate developer documentation of a Simulink model. I'd recommend Simulink Report Generator to design and automatically generate reports. Are you encountering any issues while using that?

I'm also suggesting alternatives as inquired in your question:

1. The Simulink Design Documenter on File Exchange provides tool support for semi-automated generation of Software Design Description documents for embedded systems developed using model-based design with Simulink. The purpose of the Simulink Design Documenter is to highly automate the production of useful Software Design Description documents for Simulink models, therefore significantly reducing the documentation effort.
2. Using Doxygen for generated C++ code is also a good idea. Make sure that your Simulink model is configured to include comments in the generated code & Use the Simulink and Stateflow editors to add descriptions to your model elements. You may achieve this functionality by using Code Generation Template files, or CGTs, to include doxygen-compatible file and function comment blocks in the generated code. In CGT's, comment blocks are specified using open and close tags. You can add a "style" attribute to these tags to apply doxygen formatting to the resulting comments. Please refer to the following documentation page for additional details on the different tags and attributes available: https://www.mathworks.com/help//ecoder/ug/generate-custom-file-and-function-banners.html#br86s2r

For more information on this, You may refer to:

https://www.mathworks.com/company/technical-articles/five-ways-to-document-your-simulink-model.html

[Harish]

Hi Karanjot,

your answer helped me. Thank you for the detailed description.