Join GitHub today
GitHub is home to over 50 million developers working together to host and review code, manage projects, and build software together.
Sign upConfiguration documentation should be automatically generated from the code. #843
Comments
|
@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
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:
Additional context
Ņ/A