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.

Sign up for GitHub

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

Jump to bottom

code documentation #2

Open

joreg opened this issue Dec 3, 2017 · 1 comment

Contributor

joreg commented Dec 3, 2017

how to not duplicate documentation for every implementation?
what to document, where for whom and how to automate it across implementations
can we get documentation in the kaitai file that is translated to the language specific code doc style? specifically for enums

Member

i-n-g-o commented Apr 12, 2023

Every repository for an implementation should contain a simple explained example in the readme file. similar to: https://github.com/rabbitControl/RCP/wiki/Code-examples

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment