jMonkeyEngine / jMonkeyEngine/jmonkeyengine
JavaDocs : Missing package-info on many packages
Open
Nobody has claimed this yet.
Documentation
- Dominant language
- Java
- Stars
- 4.3k
- Forks
- 1.2k
- Avg merge
- 4d 7h
- Merged PRs (30d)
- 14
Description
This is a documentation issue : many jme3 packages don't have a package-info describing what they do.
Hint :
For quick check missing package-info on different packages, you can find them on the javaDocs main site :
https://javadoc.jmonkeyengine.org/v3.5.2-stable/index.html
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
Review the javadocs main index at https://javadoc.jmonkeyengine.org/v3.5.2-stable/index.html to identify jme3 packages missing package-info documentation. Add package-info descriptions for the missing packages and confirm the generated JavaDocs describe each package.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- java
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 4/5
- Estimated time
- 3-5 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 38/100