# バッチ設計書 16-rake doc:api

## 概要

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

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

`rake doc:api`は、mrbdocコマンドを実行してYARD形式のRuby APIドキュメントを生成するRakeタスクである。mrubyのRubyレベルのAPI（クラス、メソッド、モジュール等）のドキュメントをソースコード内のYARDコメントから自動抽出し、HTMLドキュメントとして出力する。

**業務上の目的・背景**：mrubyのRuby API利用者向けのリファレンスドキュメントを自動生成するために必要なタスクである。ソースコード内のYARDフォーマットコメントからAPIドキュメントを抽出し、閲覧しやすいHTML形式で提供する。これにより、開発者がmrubyのRuby APIを理解し活用するための資料を効率的に生成できる。

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

**主要な処理内容**：
1. mrbdocコマンドを外部プロセスとして実行
2. ソースコード内のYARDコメントを解析
3. doc/api/ディレクトリにHTMLドキュメントを生成

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

**影響範囲**：`doc/api/`ディレクトリにHTMLファイル群が生成され、`.yardoc/`ディレクトリにキャッシュファイルが生成される。

## バッチ種別

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

## 実行スケジュール

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

## 実行条件

### 前提条件

| 条件 | 説明 |
|-----|------|
| Ruby実行環境 | Rubyインタプリタがインストールされていること |
| yard-mruby gem | YARD用mruby拡張gemがインストールされていること |
| yard-coderay gem | YARDのシンタックスハイライト用gemがインストールされていること |

### 実行可否判定

mrbdocコマンドが見つからない場合やyard-mruby gemが未インストールの場合、rescueブロックでエラーメッセージが表示され処理が終了するが、プロセス自体は正常終了する（例外をキャッチするため）。

## 入力仕様

### 入力パラメータ

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

### 入力データソース

| データソース | 形式 | 説明 |
|-------------|------|------|
| mrblib/*.rb | Ruby | mrubyのRubyライブラリソースファイル |
| mrbgems/**/mrblib/*.rb | Ruby | 各gemのRubyソースファイル |

## 出力仕様

### 出力データ

| 出力先 | 形式 | 説明 |
|-------|------|------|
| doc/api/ | HTML | YARD形式のAPIドキュメント |
| .yardoc/ | キャッシュ | YARDの中間キャッシュファイル |

### 出力ファイル仕様

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

## 処理フロー

### 処理シーケンス

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

### フローチャート

```mermaid
flowchart TD
    A[rake doc:api 開始] --> B[mrbdoc コマンド実行]
    B --> C{実行成功?}
    C -->|Yes| D[doc/api/ に HTML 生成]
    C -->|No| E[エラーメッセージ表示]
    E --> F[gem install 案内表示]
    D --> G[完了]
    F --> G
```

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

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

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

## エラー処理

### エラーケース一覧

| エラーコード | エラー種別 | 発生条件 | 対処方法 |
|------------|----------|---------|---------|
| N/A | コマンド未発見 | mrbdocコマンドが見つからない | gem install yard-coderay yard-mruby を実行 |
| N/A | gem未インストール | yard-mrubyまたはyard-coderayが未インストール | gem install yard-coderay yard-mruby を実行 |

### リトライ仕様

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

### 障害時対応

mrbdocコマンドの実行に失敗した場合、rescueブロックにより以下の情報が表示される：
- エラーメッセージ
- yard-coderayとyard-mrubyのインストールコマンド
- 関連するURLリンク（yardoc.org, rubygems.org）

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

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

## パフォーマンス要件

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

## 排他制御

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

## ログ出力

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

## 監視・アラート

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

## 備考

- mrbdocはyard-mruby gemに含まれるmruby専用のYARDドキュメントジェネレータである
- 生成されたドキュメントは`rake doc:view:api`でブラウザから閲覧可能
- `rake doc:clean:api`で`doc/api/`と`.yardoc/`が削除される
- 非推奨エイリアス`api_doc`も利用可能
