File: api.rst

package info (click to toggle)
groonga 16.0.0%2Bdfsg-1
  • links: PTS, VCS
  • area: main
  • in suites: forky, sid
  • size: 188,416 kB
  • sloc: ansic: 772,827; cpp: 52,396; ruby: 40,556; javascript: 10,250; yacc: 7,045; sh: 5,627; python: 2,821; makefile: 1,679
file content (27 lines) | stat: -rw-r--r-- 569 bytes parent folder | download
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
.. -*- rst -*-

API
===

Groonga can be used as a fulltext search library. This section
describes APIs that are provided by groonga.

C API Reference
---------------

See `C API Reference <https://groonga.org/docs/reference/api/index.html>`_ for auto-generated API
documentation from header files.

.. note::

   We are currently switching to automatic generation using Doxygen.
   The C API Reference link above points to the Doxygen-generated documentation.

.. toctree::
   :maxdepth: 1
   :glob:

   api/overview
   api/global_configurations
   api/plugin
   api/*