12.2.3. C API — Groonga v16.0.5 documentation

Skip to main content
`Ctrl`+`K`

# 12.2.3. C API

The C API documentation is auto-generated from header files using Doxygen. You can view the generated documentation at C API Reference.

## 12.2.3.1. How to write

To contribute to the C API documentation, add Doxygen-style comments to the header files in `include/groonga/`.

Example:

    /**
     * \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. How to preview

For instructions on how to generate documentation and preview it, see Introduction.

The generated C API HTML documentation will be output to `../groonga.doc/doc/en/html/reference/api/`.