mantle-api issueshttps://gitlab.eclipse.org/eclipse/openpass/mantle-api/-/issues2024-03-20T07:07:33Zhttps://gitlab.eclipse.org/eclipse/openpass/mantle-api/-/issues/73Proposal to add UML diagrams to docs for further clarification of the interac...2024-03-20T07:07:33ZMartin StumpProposal to add UML diagrams to docs for further clarification of the interactions between classesThe 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 ...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](https://www.doxygen.nl/manual/grouping.html).
See [add-plantuml-diagrams-to-docs](https://gitlab.eclipse.org/mstump/mantle-api/-/tree/add-plantuml-diagrams-to-docs) for a complete example using Doxygen with PlantUML and Doxygen Awesome:
![image](/uploads/c35954dbb6999edc1a9a1bb2b30a8422/image.png)
Cheers,
Martin
Martin Stump <martin.stump@mercedes-benz.com> on behalf of Mercedes-Benz Tech Innovation GmbH, [Provider Information](https://github.com/mercedes-benz/foss/blob/master/PROVIDER_INFORMATION.md)Martin StumpMartin Stumphttps://gitlab.eclipse.org/eclipse/openpass/mantle-api/-/issues/72Docs are incomplete, since the `mantle_api` ns is undocumented2024-03-20T07:07:33ZMartin StumpDocs are incomplete, since the `mantle_api` ns is undocumentedCurrently, Doxygen does not generate pages for most non-class constructs (e.g. enums and free funcs), since the `mantle_api` ns is undocumented.
Cheers,
Martin
Martin Stump <martin.stump@mercedes-benz.com> on behalf of Mercedes-Benz Te...Currently, Doxygen does not generate pages for most non-class constructs (e.g. enums and free funcs), since the `mantle_api` ns is undocumented.
Cheers,
Martin
Martin Stump <martin.stump@mercedes-benz.com> on behalf of Mercedes-Benz Tech Innovation GmbH, [Provider Information](https://github.com/mercedes-benz/foss/blob/master/PROVIDER_INFORMATION.md)Martin StumpMartin Stump