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

How to add documentation to the generated code? #6

Open
HenningHolmDE opened this issue Jun 7, 2020 · 2 comments
Open

How to add documentation to the generated code? #6

HenningHolmDE opened this issue Jun 7, 2020 · 2 comments

Comments

@HenningHolmDE
Copy link
Owner

Find a nice way for adding additional documentation to the generated code (without changing the generated files directly).

First idea: Adding documentation from a separate description file (e.g. JSON/YAML) using a post-processsing script when generating the code.

@good-praxis
Copy link
Contributor

good-praxis commented May 9, 2022

I was gonna have a look at this, but I can't get the code generation to work; Do you think you could add the generating command (and maybe version spec?) to the README.md?

I have since found the scripts, but that might be worth pointing out int he README regardless

@HenningHolmDE
Copy link
Owner Author

Glad you finally found the scripts! Good point, I should definitely add a note about that to the README.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

2 participants