操作
リファクタ #171
完了
docs/codebase-overview.md を現状に合わせて更新する
リファクタ #171:
docs/codebase-overview.md を現状に合わせて更新する
説明
Redmine #165 のコードベースレビューからの派生タスクです。
背景¶
docs/codebase-overview.md が現状のコードベースと乖離しています。
対応内容¶
- 存在しない
docs/dependencies-inventory.mdへの参照を修正または削除する。 - Java ソース数、テスト数、パッケージ一覧を現状に合わせる。
-
desktop、http、logging、runtime、service、tool、experimentalなど、現状存在するパッケージを反映する。 - Jar entry point の説明を、実際の
Main-ClassがBeatorajaLauncherでありMainLoaderに委譲する構造に合わせる。 - テストカバレッジの説明を現状に合わせる。
確認観点¶
- ドキュメント内リンクが壊れていないこと。
-
build.gradle、src/、src/test/javaの実態と説明が矛盾しないこと。
いづ さん さんが25日前に更新
- 関連している リファクタ #165: コードベースの棚卸 を追加
エージェント ちゃん さんが11日前に更新
- ステータス を 未着手 から 実装中 に変更
- 進捗率 を 0 から 10 に変更
実装に着手しました。
- ブランチ:
feature/171 - 対応方針:
docs/codebase-overview.mdを現状のコードベース（パッケージ構成・Java/テスト数・エントリポイント・存在しないdependencies-inventory.md参照）に合わせて全面更新する。
エージェント ちゃん さんが11日前に更新
- ステータス を 実装中 から 完了 に変更
- 進捗率 を 10 から 100 に変更
対応が完了しました。
概要¶
docs/codebase-overview.md が現状のコードベースと乖離していたため、パッケージ構成・ソース/テスト数・エントリポイント・存在しない参照を実態に合わせて全面更新した。
変更点¶
- 存在しない
docs/dependencies-inventory.mdへの参照を削除し、実在するdocs/構成の説明に差し替え - ソース数を更新: メイン Java 407 + テストクラス 81（合計 488）、FXML 13、リソースバンドル 6
- パッケージ表を再構築:
desktop/http/logging/runtime/service/toolを追加し、play/bga・select/bar・skin/{json,lr2,lua,property}・song/search・stream/{command,obs}のサブパッケージを上位カウントに畳み込み - Jar の
Main-ClassがBeatorajaLauncher（非JavaFXの素のmain）でMainLoaderへ委譲する構造を明記 - テストカバレッジの記述を現状の JUnit 5 スイート（約 395
@Test）に更新 - 変更ファイル:
docs/codebase-overview.md1件
テスト¶
- なし（
.javaの変更を含まない markdown 1ファイルのみの変更でコンパイル対象がないため未実行）
関連 MR¶
- !100 (feature/171 → develop)
操作