resolve #69

jbms · Apr 24, 2022 · c1e324f · c1e324f
1 parent 4defb5f
commit c1e324f
Showing 1 changed file with 6 additions and 0 deletions.
diff --git a/docs/cpp.rst b/docs/cpp.rst
@@ -10,6 +10,12 @@ C++ domain customization
 
    Defaults to :python:`True`.
 
+   .. warning::
+      This feature may not yield the expected text (for tooltips) when using sphinx extensions
+      to generate documentation that uses paragraph elements in unorthodox ways. For example,
+      using the `breathe extension <https://github.com/michaeljones/breathe>`_ to generate
+      documentation from Doxygen's XML output will reflect the odd usage of paragraphs by Doxygen.
+
    .. rst-example:: C++ synopses
 
       .. cpp:type:: synopses_ex::SomeType