apache / apache/maven-javadoc-plugin
[MJAVADOC-744] Maven coordinates in Javadoc
- Dominant language
- Java
- Stars
- 107
- Forks
- 116
- Avg merge
- 1d 10h
- Merged PRs (30d)
- 16
Description
**[Elliotte Rusty Harold](https://issues.apache.org/jira/secure/ViewProfile.jspa?name=elharo)** opened **[MJAVADOC-744](https://issues.apache.org/jira/browse/MJAVADOC-744?redirect=false)** and commented
Add an option to the javadoc plugin to include the Maven coordinates (group:artifact:version) of a class in its Javadoc.
I noticed this morning for about the 173rd time that I could google for the API doc of a class I needed, but still couldn't figure out which artifact I needed to add to my pom.xml to include that class in my project.
---
No further details from [MJAVADOC-744](https://issues.apache.org/jira/browse/MJAVADOC-744?redirect=false)
Contributor guide
No contributing guide indexed for this repository
Research direction
No source files or tests are named in the issue. Start by locating the Maven Javadoc Plugin's option handling and Javadoc generation entry points, then determine how group:artifact:version should be associated with each class. Done means a documented plugin option can include the Maven coordinates in generated Javadoc, with coverage for the resulting output.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- java
- Domain
- build-system, documentation
- Issue type
- Feature
- Difficulty
- 5/5
- Estimated time
- Over a week
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 30/100