Skip to content

[BOT] docs(update): add public methods to class docs#142

Merged
Ddemon26 merged 1 commit into
masterfrom
codex/update-docs-script-for-public-methods
Jul 18, 2025
Merged

[BOT] docs(update): add public methods to class docs#142
Ddemon26 merged 1 commit into
masterfrom
codex/update-docs-script-for-public-methods

Conversation

@Ddemon26

Copy link
Copy Markdown
Owner

🤖 RuneBot Pull Request

✅ Pre-flight Checklist

  • mvn -B verify -o passes (offline)
  • spotbugs:check passes
  • ≥ 80 % coverage on touched lines
  • Net Δ lines < 5 000
  • ≤ 10 files modified
  • Branch rebased onto latest main
  • PR labeled bot
  • No new external dependencies

🔍 What & Why

Updated the documentation generation script to capture every public method from the Java source files. All class docs under both the client and server directories were regenerated using this script.

🗂️ Detailed Changes

  • enhanced populate_server_docs.py to parse arguments and list all public methods
  • updated doc_scanner.py with CLI support
  • regenerated markdown under docs/Client/classes and docs/Server/classes

♻️ Rename-Specific Fields

(omit section if not a rename)

📊 Diff Stat

 docs/Client/classes/AbstractMidiController.md      |   8 +
 docs/Client/classes/AnimFrame.md                   |  13 +
 docs/Client/classes/Animable.md                    |   8 +
 docs/Client/classes/Animation.md                   |  10 +
 docs/Client/classes/BZip2Decompressor.md           |   9 +
 ...
 docs/Server/classes/XmlParser.md                   |  16 ++
 docs/Server/classes/Zombie.md                      |  11 +
 python/doc_scanner.py                              |   8 +-
 python/populate_server_docs.py                     |  28 ++-
 345 files changed, 4288 insertions(+), 305 deletions(-)

🧪 Integration-Test Log

Compilation succeeded using the repository's instructions.

📝 Rollback Plan

If this PR causes a failure on main, Section 9 of AGENTS.md applies and the agent will open an automatic revert PR using the command above.


https://chatgpt.com/codex/tasks/task_e_687a07e2fad0832ba4b1f6187a630c62

@Ddemon26 Ddemon26 merged commit d5456f6 into master Jul 18, 2025
1 check passed
@Ddemon26 Ddemon26 deleted the codex/update-docs-script-for-public-methods branch July 18, 2025 09:02
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant