# バッチ設計書 17-rake doc:capi

## 概要

本ドキュメントは、mrubyプロジェクトにおけるDoxygenドキュメント（C APIドキュメント）を生成する`rake doc:capi`タスクのバッチ設計書である。

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

`rake doc:capi`は、Doxygenを使用してmrubyのC APIドキュメントを生成するRakeタスクである。プロジェクトルートの`Doxyfile`設定ファイルに基づいて、CヘッダーファイルおよびソースファイルのDoxygenコメントからAPIリファレンスドキュメントをHTML形式で自動生成する。

**業務上の目的・背景**：mrubyのCレベルAPI（mrb_state操作、値操作、クラス定義等）の利用者向けリファレンスドキュメントを自動生成するために必要なタスクである。組み込み開発者やCエクステンション開発者がmrubyのC APIを理解し活用するための資料を提供する。

**バッチの実行タイミング**：開発者による手動実行。C APIの変更やDoxygenコメントの更新時に実行される。`rake doc`タスクからも間接的に呼び出される。

**主要な処理内容**：
1. `doxygen Doxyfile`コマンドを外部プロセスとして実行
2. Cヘッダーファイル（include/mruby/*.h）内のDoxygenコメントを解析
3. doc/capi/ディレクトリにHTMLドキュメントを生成

**前後の処理との関連**：`rake doc`タスクの一部として`doc:api`と共に呼び出される。`doc:clean:capi`タスクで生成物を削除可能。`doc:view:capi`タスクで生成されたドキュメントをブラウザで閲覧可能。

**影響範囲**：`doc/capi/`ディレクトリにDoxygenが生成するHTMLファイル群が出力される。Doxyfileの`OUTPUT_DIRECTORY`設定により`doc/capi`が出力先となっている。

## バッチ種別

ドキュメント生成（C APIドキュメント）

## 実行スケジュール

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

## 実行条件

### 前提条件

| 条件 | 説明 |
|-----|------|
| Doxygen | Doxygenがインストールされていること |
| Graphviz | Graphvizがインストールされていること（グラフ生成に必要） |
| Doxyfile | プロジェクトルートにDoxyfileが存在すること |

### 実行可否判定

doxygenコマンドが見つからない場合やDoxyfileが不正な場合、rescueブロックでエラーメッセージが表示され処理が終了するが、プロセス自体は正常終了する。

## 入力仕様

### 入力パラメータ

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

### 入力データソース

| データソース | 形式 | 説明 |
|-------------|------|------|
| Doxyfile | 設定ファイル | Doxygenの設定ファイル（プロジェクト名、出力先、対象ファイル等） |
| include/mruby/*.h | C Header | mrubyのCヘッダーファイル（Doxygenコメント含む） |
| src/*.c | C Source | mrubyのCソースファイル |

## 出力仕様

### 出力データ

| 出力先 | 形式 | 説明 |
|-------|------|------|
| doc/capi/ | HTML | Doxygenで生成されたC APIドキュメント |

### 出力ファイル仕様

| 項目 | 内容 |
|-----|------|
| ファイル名 | html/index.htmlを起点とするHTMLファイル群 |
| 出力先 | doc/capi/ |
| 文字コード | UTF-8 |
| プロジェクト名 | mruby |
| プロジェクトバージョン | 3.4.0（Doxyfile定義） |

## 処理フロー

### 処理シーケンス

```
1. doxygenコマンドの実行
   └─ sh "doxygen Doxyfile" で外部プロセスとして実行
2. 正常完了の場合
   └─ doc/capi/にHTMLドキュメントが生成される
3. 異常終了の場合（rescue）
   └─ Doxygen/Graphvizのインストール案内を表示
```

### フローチャート

```mermaid
flowchart TD
    A[rake doc:capi 開始] --> B[doxygen Doxyfile 実行]
    B --> C{実行成功?}
    C -->|Yes| D[doc/capi/ に HTML 生成]
    C -->|No| E[エラーメッセージ表示]
    E --> F[Doxygen/Graphviz インストール案内表示]
    D --> G[完了]
    F --> G
```

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

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

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

## エラー処理

### エラーケース一覧

| エラーコード | エラー種別 | 発生条件 | 対処方法 |
|------------|----------|---------|---------|
| N/A | doxygen未インストール | doxygenコマンドが見つからない | Debian: apt-get install doxygen graphviz / RHEL: dnf install doxygen graphviz / macOS: brew install doxygen graphviz |
| N/A | Doxyfile不正 | Doxyfileの設定が不正な場合 | Doxyfileの内容を確認・修正 |

### リトライ仕様

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

### 障害時対応

doxygenコマンドの実行に失敗した場合、rescueブロックにより各OS向けのインストールコマンドが表示される：
- Debian系: `sudo apt-get install doxygen graphviz`
- RHEL系: `sudo dnf install doxygen graphviz`
- macOS: `brew install doxygen graphviz`

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

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

## パフォーマンス要件

| 項目 | 内容 |
|-----|------|
| 想定処理件数 | C/Hファイル数に依存 |
| 目標処理時間 | 数十秒〜数分 |
| メモリ使用量上限 | 特に制限なし |

## 排他制御

同時実行の制限は特にないが、同じ出力ディレクトリへの同時書き込みは避けるべきである。

## ログ出力

| ログ種別 | 出力タイミング | 出力内容 |
|---------|--------------|---------|
| 進捗ログ | ドキュメント生成中 | Doxygenの標準出力 |
| エラーログ | doxygen失敗時 | OS別インストール案内メッセージ |

## 監視・アラート

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

## 備考

- Doxyfileの主な設定：プロジェクト名=mruby、バージョン=3.4.0、出力先=doc/capi、文字コード=UTF-8、出力言語=English
- プロジェクトロゴとしてdoc/mruby_logo_red_icon.pngが使用される
- 生成されたドキュメントは`rake doc:view:capi`でブラウザから閲覧可能（macOS: open、Linux: xdg-open）
- `rake doc:clean:capi`で`doc/capi`ディレクトリが削除される
- 非推奨エイリアス`capi_doc`も利用可能
