Proposal to add UML diagrams to docs for further clarification of the interactions between classes

The documentation currently only shows, how singular classes and functions can be used. However, it does not clarify how multiple classes and functions are meant to interact.

I propose to add UML diagrams to the documentation, wherever it makes sense to clarify such interaction.

To that end, we should settle on a definition of, and consise wording for the different subdomains covered by the API:

• Environment
• Scenario
• Simulator (Execution)
• ...

The diagrams could be added to a page that Doxygen calls a Topic.

See add-plantuml-diagrams-to-docs for a complete example using Doxygen with PlantUML and Doxygen Awesome:

Cheers, Martin

Martin Stump martin.stump@mercedes-benz.com on behalf of Mercedes-Benz Tech Innovation GmbH, Provider Information