# バッチ設計書 15-rake doc

## 概要

本ドキュメントは、mrubyプロジェクトにおけるYARDドキュメントとDoxygenドキュメントの両方を生成する`rake doc`タスクのバッチ設計書である。

### 本バッチの処理概要

`rake doc`は、mrubyのAPIドキュメント生成を統括するRakeタスクである。`doc:api`（YARDドキュメント）と`doc:capi`（Doxygenドキュメント）の2つのサブタスクを依存関係として実行し、Ruby APIとC APIの両方のドキュメントを一括生成する。

**業務上の目的・背景**：mrubyの開発者向けドキュメントを自動生成するために必要なタスクである。Ruby APIドキュメント（YARD形式）とC APIドキュメント（Doxygen形式）を一括して生成することで、ドキュメントの保守コストを削減し、ソースコードとドキュメントの同期を維持する。

**バッチの実行タイミング**：開発者による手動実行。ドキュメントの更新が必要な際やリリース前のドキュメント生成時に実行される。

**主要な処理内容**：
1. `doc:api`タスクの実行（mrbdocコマンドによるYARDドキュメント生成）
2. `doc:capi`タスクの実行（doxygenコマンドによるC APIドキュメント生成）

**前後の処理との関連**：前提タスクはない。`doc:clean`タスクで生成したドキュメントを削除可能。`deep_clean`タスクからも`doc:clean`が呼び出される。

**影響範囲**：`doc/api/`ディレクトリにYARDドキュメント、`doc/capi/`ディレクトリにDoxygenドキュメントが生成される。既存のドキュメントは上書きされる。

## バッチ種別

ドキュメント生成

## 実行スケジュール

| 項目 | 内容 |
|-----|------|
| 実行頻度 | 随時 |
| 実行時刻 | 任意 |
| 実行曜日 | 該当なし |
| 実行日 | 該当なし |
| トリガー | 手動実行 |

## 実行条件

### 前提条件

| 条件 | 説明 |
|-----|------|
| Ruby実行環境 | Rubyインタプリタがインストールされていること |
| yard-mruby gem | YARDドキュメント生成に必要（doc:api用） |
| yard-coderay gem | YARDドキュメント生成に必要（doc:api用） |
| Doxygen | C APIドキュメント生成に必要（doc:capi用） |
| Graphviz | Doxygenのグラフ生成に必要（doc:capi用） |

### 実行可否判定

本タスク自体に実行可否判定はない。ただし、サブタスク（doc:apiおよびdoc:capi）でそれぞれ必要なツールが未インストールの場合、エラーメッセージが表示される（処理は継続される）。

## 入力仕様

### 入力パラメータ

| パラメータ名 | 型 | 必須 | デフォルト値 | 説明 |
|-------------|-----|-----|-------------|------|
| なし | - | - | - | 本タスクにパラメータはない |

### 入力データソース

| データソース | 形式 | 説明 |
|-------------|------|------|
| ソースコード（*.rb, *.c, *.h） | Ruby/C | YARD/Doxygenのドキュメントコメントを含むソースファイル |
| Doxyfile | 設定ファイル | Doxygenの設定ファイル |

## 出力仕様

### 出力データ

| 出力先 | 形式 | 説明 |
|-------|------|------|
| doc/api/ | HTML | YARDで生成されたRuby APIドキュメント |
| doc/capi/ | HTML | Doxygenで生成されたC APIドキュメント |
| .yardoc/ | YARDキャッシュ | YARD生成時の中間ファイル |

### 出力ファイル仕様

| 項目 | 内容 |
|-----|------|
| ファイル名 | index.htmlを起点とするHTMLファイル群 |
| 出力先（API） | doc/api/ |
| 出力先（CAPI） | doc/capi/ |
| 文字コード | UTF-8 |

## 処理フロー

### 処理シーケンス

```
1. doc:apiタスクの実行
   └─ mrbdocコマンドによるYARDドキュメント生成
   └─ 失敗時はエラーメッセージを表示して継続
2. doc:capiタスクの実行
   └─ doxygen Doxyfileコマンドによるドキュメント生成
   └─ 失敗時はエラーメッセージを表示して継続
```

### フローチャート

```mermaid
flowchart TD
    A[rake doc 開始] --> B[doc:api タスク実行]
    B --> C{mrbdoc 実行成功?}
    C -->|Yes| D[YARD ドキュメント生成完了]
    C -->|No| E[エラーメッセージ表示]
    D --> F[doc:capi タスク実行]
    E --> F
    F --> G{doxygen 実行成功?}
    G -->|Yes| H[Doxygen ドキュメント生成完了]
    G -->|No| I[エラーメッセージ表示]
    H --> J[完了]
    I --> J
```

## データベース操作仕様

### 操作別データベース影響一覧

本バッチはデータベースを使用しない。

## エラー処理

### エラーケース一覧

| エラーコード | エラー種別 | 発生条件 | 対処方法 |
|------------|----------|---------|---------|
| N/A | mrbdoc未インストール | yard-mruby gemがインストールされていない | gem install yard-coderay yard-mruby を実行 |
| N/A | doxygen未インストール | Doxygenがインストールされていない | パッケージマネージャでdoxygenとgraphvizをインストール |

### リトライ仕様

| 項目 | 内容 |
|-----|------|
| リトライ回数 | なし |
| リトライ間隔 | N/A |
| リトライ対象エラー | N/A |

### 障害時対応

各サブタスクは独立してエラーハンドリングを行い、ツール未インストール時にはインストール手順を含むエラーメッセージを表示する。一方のサブタスクが失敗しても他方は実行される。

## トランザクション仕様

| 項目 | 内容 |
|-----|------|
| トランザクション範囲 | N/A |
| コミットタイミング | N/A |
| ロールバック条件 | N/A |

## パフォーマンス要件

| 項目 | 内容 |
|-----|------|
| 想定処理件数 | ソースファイル数に依存 |
| 目標処理時間 | 数分程度 |
| メモリ使用量上限 | 特に制限なし |

## 排他制御

同時実行の制限はないが、同じ出力ディレクトリに対する同時書き込みは想定されていない。

## ログ出力

| ログ種別 | 出力タイミング | 出力内容 |
|---------|--------------|---------|
| 進捗ログ | ドキュメント生成中 | YARD/Doxygenの標準出力 |
| エラーログ | ツール未インストール時 | インストール手順を含むエラーメッセージ |

## 監視・アラート

| 監視項目 | 閾値 | アラート先 |
|---------|-----|----------|
| 処理完了 | N/A | 手動確認 |

## 備考

- `rake doc`はdoc:apiとdoc:capiの統括タスクであり、個別に実行することも可能
- doc:view:apiおよびdoc:view:capiタスクで生成されたドキュメントをブラウザで開くことができる
- 非推奨のエイリアスタスク（api_doc、capi_doc）も存在する
