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

Include comments in generated output #10

Open
3 of 5 tasks
mithro opened this issue Jul 7, 2019 · 0 comments
Open
3 of 5 tasks

Include comments in generated output #10

mithro opened this issue Jul 7, 2019 · 0 comments

Comments

@mithro
Copy link
Member

mithro commented Jul 7, 2019

I think it would be useful to include comments in your generated parser output.

Suggested comments are;

  • Header which warns this file is generated and should not be modified directly.
  • Links and information (md5sum etc) to the xsd the file was generated from.
  • Before each structure, a copy of the xsd section which was used to generate the structure.
  • Before each parsing function, an example of the XML that is parsed by this function.
  • More?
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

1 participant