summaryrefslogtreecommitdiffstats
path: root/doc/lib.rst
diff options
context:
space:
mode:
Diffstat (limited to 'doc/lib.rst')
-rw-r--r--doc/lib.rst58
1 files changed, 58 insertions, 0 deletions
diff --git a/doc/lib.rst b/doc/lib.rst
new file mode 100644
index 0000000..6eeaa13
--- /dev/null
+++ b/doc/lib.rst
@@ -0,0 +1,58 @@
+.. _lib_index:
+
+.. include:: ../lib/README.rst
+
+API reference
+=============
+
+.. 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
+
+.. _lib_api_nameservers:
+
+Nameservers
+-----------
+
+.. doxygenfile:: nsrep.h
+ :project: libkres
+.. doxygenfile:: zonecut.h
+ :project: libkres
+
+.. _lib_api_modules:
+
+Modules
+-------
+
+.. doxygenfile:: module.h
+ :project: libkres
+
+Utilities
+---------
+
+.. doxygenfile:: utils.h
+ :project: libkres
+.. doxygenfile:: defines.h
+ :project: libkres
+
+.. _lib_generics:
+
+.. include:: ../lib/generic/README.rst