From: Vladimír Vondruš <mosra@centrum.cz>
Date: Sun, 11 Feb 2018 17:39:22 +0000 (+0100)
Subject: doc: \section commands elsewhere than top-level docs are not supported.
X-Git-Url: https://www.chiark.greenend.org.uk/ucgi/~cjwatson/git?a=commitdiff_plain;h=7f898d2889bb94ef9399c70cebfe74a554cecfba;p=blog.git

doc: \section commands elsewhere than top-level docs are not supported.

The visual layout is not ready for such thing at all.
---

diff --git a/doc/doxygen.rst b/doc/doxygen.rst
index 4cd7a096..e88900c6 100644
--- a/doc/doxygen.rst
+++ b/doc/doxygen.rst
@@ -204,6 +204,9 @@ amount of generated content for no added value.
     accompanied with corresponding tutorial page instead)
 -   :cpp:`inline` functions are not marked as such (I see it as an unimportant
     implementation detail)
+-   ``@section``, ``@subsection`` etc. commands inside anything else than
+    top-level documentation of a class, namespace, file, directory, page or
+    module are not supported as the visual layout is not expecting such things
 
 `Not yet implemented features`_
 -------------------------------