Search code examples
doxygenpython-sphinxdocumentation-generationdymola

Automatic documentation generation for Dymola code


since I could not find an answer to my question neither here nor in other forums, I decided to ask it to the community:

Does anybody know if and how it is possible to realize automatic documentation generation for code generated with Dymola?

The background for this e. g. is that I want/need to store additional information within my model files to explain the concepts of my modelling and to store and get the documentation directly from the model code, which I would later like to be in a convenient way displayable not only from within Dymola, but also by a html and LaTeX documentation.

I know that there exist several tools for automatic documentation generation like e. g. DoxyGen and Python Sphinx, but I could not figure out if the can be used with Dymola code. Plus, I am pretty new to this topic, so that I do not really know how to find out if they will work out.

Thank you people very much for your help!

Greetings, mindm49907


Solution

  • If you mean the Modelica model code, how does the HTML export in Dymola work for you? What's missing?

    If you mean the C code generated by Dymola, the source code generation option enables more comments in the code.