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

Configuration documentation should be automatically generated from the code. #843

Open
gawi opened this issue Sep 21, 2018 · 1 comment
Open

Comments

@gawi
Copy link

@gawi gawi commented Sep 21, 2018

Is your feature request related to a problem? Please describe.

Configuration options are not documented on the web site.

Describe the solution you'd like

I need to look at the code (i.e. the *Config classes) or at the Javadoc in order to determine the configuration options. I'd like to have it documented on the website and to be sure that the configuration options match whatever is in the code for a given version.

Describe alternatives you've considered

I've tried to do it myself but I guess it should be much more relevant for the project maintainers to do it themselves.

To document classes and their properties, you can use one of the following approaches:

  • documentation-specific Java annotations + create an annotation processor to generate the documentation
  • Javadoc documentation + create a specialized Doclet for *Config classes.

Additional context

Ņ/A

@johnou
Copy link
Member

@johnou johnou commented Oct 27, 2018

@gawi do you have time to create a prototype / poc or do you have some specific examples? is the javadoc not clear enough?

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

Successfully merging a pull request may close this issue.

None yet
2 participants
You can’t perform that action at this time.