hcloud-rust icon indicating copy to clipboard operation
hcloud-rust copied to clipboard

How to add documentation to the generated code?

Open HenningHolmDE opened this issue 5 years ago • 2 comments

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.

HenningHolmDE avatar Jun 07 '20 15:06 HenningHolmDE

~~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

good-praxis avatar May 09 '22 16:05 good-praxis

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

HenningHolmDE avatar May 10 '22 15:05 HenningHolmDE