Generate documentation during the standard Javadoc build cycle
- Dominant language
- Java
- Stars
- 25
- Forks
- 34
- PR merge metrics
- No merged PRs in 30d
Description
**This is a research task**
The result of this task might be a code example of a working [doclet](https://javadoc.scijava.org/Java9/jdk/javadoc/doclet/package-summary.html) that inserts a comment about AndHow properties when one if found in an applications code. From there, we can decide how to really implement this.
This task is about finding a way for AndHow to generate documentation of application properties that are included in the javadoc output of the user's application.
When AndHow experiences a failed startup, it generates sample configuration files. A typical sample properties file looks like this:
```properties
# ######################################################################
# Property Group org.simple.GettingStarted
# COUNT_DOWN_START (Integer) NON-NULL - Start the countdown from this number
# The property value must be greater than or equal to 1
org.simple.GettingStarted.COUNT_DOWN_START = [Integer]
# LAUNCH_CMD (String) NON-NULL - What to say when its time to launch
# The property value must match the regex expression '.*Go.*'
org.simple.GettingStarted.LAUNCH_CMD = [String]
```
Wouldn't it be nice if all of that was included in the HTML JavaDocs that were created for a project? I think to do this would require a maven plugin.
Contributor guide
Assessment
This issue has not been assessed yet.