From f9113b6e1bda6575749d9e1f8ca9c8af4b020bbc Mon Sep 17 00:00:00 2001 From: Tomas Krizek Date: Tue, 14 Apr 2020 16:36:28 +0200 Subject: [PATCH] doc/lib: add warning about potential doc inaccuracies --- doc/lib.rst | 4 ++++ 1 file changed, 4 insertions(+) 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: -- 2.47.2