Document all public API
Open
Nobody has claimed this yet.
- Dominant language
- Java
- Stars
- 1.4k
- Forks
- 350
- PR merge metrics
- No merged PRs in 30d
Description
The ImageJ2 and ImgLib2 core classes must have full javadoc of all classes and public methods.
Migrated-From: http://trac.imagej.net/ticket/1015
Contributor guide
No contributing guide indexed for this repository
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 ImageJ2 and ImgLib2 core classes and identifying which classes and public methods lack Javadoc. The issue provides no file list, entry point, or verification test, so define the inventory and completion criteria before beginning. Done means all core classes and public methods have full Javadoc.
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
- 20/100