From: Tomas Krizek <tomas.krizek@nic.cz>
Date: Tue, 14 Apr 2020 14:36:28 +0000 (+0200)
Subject: doc/lib: add warning about potential doc inaccuracies
X-Git-Tag: v5.1.0~12^2~2
X-Git-Url: http://git.ipfire.org/cgi-bin/gitweb.cgi?a=commitdiff_plain;h=f9113b6e1bda6575749d9e1f8ca9c8af4b020bbc;p=thirdparty%2Fknot-resolver.git

doc/lib: add warning about potential doc inaccuracies
---

diff --git a/doc/lib.rst b/doc/lib.rst
index ae935d356..101767fe5 100644
--- a/doc/lib.rst
+++ b/doc/lib.rst
@@ -7,6 +7,10 @@
 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: