12.2.3. C API — Groonga v16.0.4ドキュメント

本文へスキップ
`Ctrl`+`K`

# 12.2.3. C API

C APIのドキュメントは、ヘッダーファイルからDoxygenを用いて自動生成しています。生成されたドキュメントはC API Referenceで確認できます。

## 12.2.3.1. 書き方

C API のドキュメントに貢献するには、`include/groonga/`配下のヘッダーファイルにDoxygen形式のコメントを追加してください。

例：

    /**
     * \brief Short description of the function
     *
     * Detailed description here.
     *
     * \param ctx The context
     * \param arg Description of the argument
     * \return Description of the return value
     */
    GRN_API grn_rc grn_function(grn_ctx *ctx, int arg);

## 12.2.3.2. プレビュー方法

ドキュメントの生成方法およびプレビュー方法については、導入を参照してください。

生成されたC APIのHTMLドキュメントは、次の`../groonga.doc/doc/en/html/reference/api/`ディレクトリに出力されます。