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.

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

Support configuration struct tags in the documentation generator #144

Open
ppar opened this issue Jun 16, 2017 · 0 comments
Open

Support configuration struct tags in the documentation generator #144

ppar opened this issue Jun 16, 2017 · 0 comments
Labels
documentation enhancement

Comments

@ppar
Copy link
Contributor

ppar commented Jun 16, 2017

The documentation generator at ./docs/generator/ could support the config struct tags introduced in #143 to:

  • Detect undocumented configuration parameters and include them in the documentation
  • Detetect and warn about inexistent / mistyped configuration parameters found in the doc comments

Not a very urgent need, but perhaps useful when revising documentation in the future.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
documentation enhancement
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
2 participants
@ppar @msiebeneicher