chiark / gitweb /
doc: \section commands elsewhere than top-level docs are not supported.
authorVladimír Vondruš <mosra@centrum.cz>
Sun, 11 Feb 2018 17:39:22 +0000 (18:39 +0100)
committerVladimír Vondruš <mosra@centrum.cz>
Sun, 11 Feb 2018 17:39:22 +0000 (18:39 +0100)
The visual layout is not ready for such thing at all.

doc/doxygen.rst

index 4cd7a096164ec63d8ad00796ef77fde5da64aaf3..e88900c63f09e8f988110935ac5934f59587ef61 100644 (file)
@@ -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`_
 -------------------------------