summaryrefslogtreecommitdiffstats
path: root/doc/lib.rst
blob: 33e2ff3e9033cdd943e285e0ce9cf4bd17d18b75 (plain)
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
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
.. SPDX-License-Identifier: GPL-3.0-or-later

.. _lib_index:

.. include:: ../lib/README.rst

API reference
=============

.. warning:: This section is generated with doxygen and breathe. Due to their
   limitations, some symbols may be incorrectly described or missing entirely.
   For exhaustive and accurate reference, refer to the header files instead.

.. contents::
   :depth: 1
   :local:

.. _lib_api_rplan:

Name resolution
---------------

.. doxygenfile:: resolve.h
   :project: libkres
.. doxygenfile:: rplan.h
   :project: libkres

.. _lib_api_cache:

Cache
-----

.. doxygenfile:: cache/api.h
   :project: libkres

.. doxygenfile:: cache/impl.h
   :project: libkres

.. _lib_api_nameservers:

Nameservers
-----------

.. doxygenfile:: selection.h
   :project: libkres
.. doxygenfile:: zonecut.h
   :project: libkres

.. _lib_api_modules:

Modules
-------

.. doxygenfile:: module.h
   :project: libkres

.. doxygenfile:: layer.h
   :project: libkres

Utilities
---------

.. doxygenfile:: utils.h
   :project: libkres
.. doxygenfile:: defines.h
   :project: libkres

.. _lib_generics:

.. include:: ../lib/generic/README.rst