GlowstoneMC / GlowstoneMC/Glowstone

Code Documentation (JavaDocs)

Open
#359 3 comments 0 reactions 0 assignees View on GitHub
Type: story
Dominant language
Java
Stars
2k
Forks
280
PR merge metrics
No merged PRs in 30d

Description

Glowstone is sorely lacking in the documentation department. Improvements to in-code JavaDocs and comments are possible, and it might be worth writing up some separate code documentation or user guides on the [GitHub wiki](https://github.com/GlowstoneMC/Glowstone/wiki).

Methods which override or implement Bukkit interfaces do not need separate documentation unless there is an important note or exception to be made; otherwise, omit JavaDoc entirely and refer to implemented method JavaDoc.

---
Want to back this issue? **[Post a bounty on it!](https://www.bountysource.com/issues/37408324-code-documentation-javadocs?utm_campaign=plugin&utm_content=tracker%2F14691067&utm_medium=issues&utm_source=github)** We accept bounties via [Bountysource](https://www.bountysource.com/?utm_campaign=plugin&utm_content=tracker%2F14691067&utm_medium=issues&utm_source=github).

Contributor guide

Open the contributing guide

Research direction

The issue names no specific files, tests, or entry points. Start by reviewing the Java source for missing JavaDocs and comments, while checking implemented Bukkit interface methods for documentation that should be omitted. Done would require a defined documentation scope and completed JavaDocs, comments, or user guides, but the issue does not specify which items are required.

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

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.