Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Detailed function documentation #75

Open
ReinhardKeil opened this issue Mar 10, 2025 · 0 comments
Open

Detailed function documentation #75

ReinhardKeil opened this issue Mar 10, 2025 · 0 comments
Assignees
Labels
documentation Improvements or additions to documentation sds-core Belongs to SDS-Framework/sds

Comments

@ReinhardKeil
Copy link
Contributor

ReinhardKeil commented Mar 10, 2025

We will use a doyxgen approach to create the sds function documentation.

ToDo a txt file with detailed information about each function and an example for each function group.

The following commands generate the *.md files from Doxygen that are included in MKDocs.

doxygen
npx moxygen -i ./documentation/doxygen/xml -o ./documentation/api

Note: on windows this requires nodejs that can be installed from https://nodejs.org

@MiloradCvjetkovic MiloradCvjetkovic added documentation Improvements or additions to documentation sds-core Belongs to SDS-Framework/sds labels Mar 12, 2025
@MiloradCvjetkovic MiloradCvjetkovic moved this to Backlog in SDS Framework Mar 12, 2025
@MiloradCvjetkovic MiloradCvjetkovic self-assigned this Mar 12, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation sds-core Belongs to SDS-Framework/sds
Projects
Status: Backlog
Development

No branches or pull requests

2 participants