Skip to content

Improve documentation consistency and remove obsolete CheerpJ implementation#72

Merged
Project516 merged 4 commits into
masterfrom
copilot/improve-documentation-style
Oct 27, 2025
Merged

Improve documentation consistency and remove obsolete CheerpJ implementation#72
Project516 merged 4 commits into
masterfrom
copilot/improve-documentation-style

Conversation

Copy link
Copy Markdown
Contributor

Copilot AI commented Oct 27, 2025

Addressed missing Javadoc coverage and inconsistent documentation across shell scripts to improve codebase accessibility for new contributors.

Changes

Java Documentation

  • Added class-level Javadoc to NumberGuessingGame explaining console game loop and error recovery
  • Documented ScannerHelper.next() for input stream clearing after exceptions
  • Documented CheckGuess.quit() for play-again validation

Shell Script Documentation

  • Added purpose, output, and usage comments to all packaging and testing scripts
  • Clarified differences between platform-specific packaging approaches (macOS JRE structure differs from Linux/Windows)
  • Explained build dependencies in test scripts (.bat requires manual build, .sh auto-builds)

Cleanup

  • Removed obsolete CheerpJ implementation (replaced by TeaVM in previous work)
    • Deleted cheerpj.sh and cheerpj/ directory
    • Updated teavm.sh comments to reflect replacement

Example of improved documentation style:

/**
 * Console-based Number Guessing Game implementation. This class manages the console version of the
 * game, handling the game loop, user interaction, and error recovery. It prompts the user to guess
 * numbers and allows replaying the game.
 */
public class NumberGuessingGame {
    /**
     * Runs the console version of the Number Guessing Game. Initializes all game components,
     * displays debug information, and manages the game loop. The user can play multiple rounds
     * until they choose to quit.
     */
    void run() {
Original prompt

Make sure everything is documented, in a consostant style, easy for newbies to read, amd clean up the unneeded things


💡 You can make Copilot smarter by setting up custom instructions, customizing its development environment and configuring Model Context Protocol (MCP) servers. Learn more Copilot coding agent tips in the docs.

Copilot AI and others added 3 commits October 27, 2025 18:44
Co-authored-by: Project516 <138796702+Project516@users.noreply.github.com>
Co-authored-by: Project516 <138796702+Project516@users.noreply.github.com>
Co-authored-by: Project516 <138796702+Project516@users.noreply.github.com>
Copilot AI changed the title [WIP] Update documentation for consistency and clarity Improve documentation consistency and remove obsolete CheerpJ implementation Oct 27, 2025
Copilot AI requested a review from Project516 October 27, 2025 18:53
@Project516 Project516 marked this pull request as ready for review October 27, 2025 18:54
@Project516 Project516 merged commit c300a85 into master Oct 27, 2025
3 checks passed
@Project516 Project516 deleted the copilot/improve-documentation-style branch October 27, 2025 18:55
Project516 added a commit that referenced this pull request Feb 23, 2026
…style

Improve documentation consistency and remove obsolete CheerpJ implementation
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants