goxr3plus / goxr3plus/XR3Player

Complete/Fix/Standardize JavaDoc

Open
#4 4 comments 1 reaction 1 assignee Claimed by @goxr3plus View on GitHub
enhancement wontfix
Dominant language
Java
Stars
771
Forks
183
PR merge metrics
No merged PRs in 30d

Description

1. Write JavaDoc comments for all class variables and functions.
2. In many cases, there are multi-line JavaDoc comments where the opening ```/**``` and closing ```*/``` could be moved onto the same line as the comment itself.
3. There are functions with unfinished JavaDoc comments.
4. JavaDoc comments on classes can be removed if they have no useful information (Ex. A one-line description of the class and author tag).

Contributor guide

Open the contributing guide

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.