Generate module-style Javadoc
Open
Nobody has claimed this yet.
documentation
- Dominant language
- Java
- Stars
- 1.1k
- Forks
- 43
- Avg merge
- 9m
- Merged PRs (30d)
- 13
Description
To avoid:
warning: The code being documented uses modules but the packages defined in https://jspecify.dev/docs/api/ are in the unnamed module.
See https://github.com/jspecify/jspecify/issues/484#issuecomment-2504349649.
The big question would be whether generating module-style Javadoc makes it harder for non-module users to link to us.
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Start by reviewing the Javadoc warning, the API documentation at https://jspecify.dev/docs/api/, and the linked discussion in jspecify/jspecify#484. Determine whether module-style generation can remove the warning without making links harder for non-module users; done means this trade-off is resolved and the generation approach is documented.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- java
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 5/5
- Estimated time
- Over a week
- Activity status
- Stale
- Clarity
- Needs clarification
- Newbie friendliness
- 30/100