From aebdb60a4a47fef54307e2bad4bcd488f71daac8 Mon Sep 17 00:00:00 2001 From: =?utf8?q?Vladim=C3=ADr=20Vondru=C5=A1?= Date: Mon, 10 Jan 2022 19:56:36 +0100 Subject: [PATCH] documentation/doxygen: dedicated test for Doxygen 1.9 blockquote bugs. And removing the problematic interaction from the general typography test -- it's now here instead. --- .../test_doxygen/contents_blockquote/Doxyfile | 14 ++++++++ .../contents_blockquote/index.html | 33 +++++++++++++++++++ .../contents_blockquote/input.dox | 32 ++++++++++++++++++ .../contents_typography/index.html | 4 +-- .../contents_typography/input.dox | 4 +-- documentation/test_doxygen/test_contents.py | 5 +++ 6 files changed, 88 insertions(+), 4 deletions(-) create mode 100644 documentation/test_doxygen/contents_blockquote/Doxyfile create mode 100644 documentation/test_doxygen/contents_blockquote/index.html create mode 100644 documentation/test_doxygen/contents_blockquote/input.dox diff --git a/documentation/test_doxygen/contents_blockquote/Doxyfile b/documentation/test_doxygen/contents_blockquote/Doxyfile new file mode 100644 index 00000000..07979766 --- /dev/null +++ b/documentation/test_doxygen/contents_blockquote/Doxyfile @@ -0,0 +1,14 @@ +INPUT = input.dox +QUIET = YES +GENERATE_HTML = NO +GENERATE_LATEX = NO +GENERATE_XML = YES +XML_PROGRAMLISTING = NO +CASE_SENSE_NAMES = YES + +##! M_PAGE_FINE_PRINT = +##! M_THEME_COLOR = +##! M_FAVICON = +##! M_LINKS_NAVBAR1 = +##! M_LINKS_NAVBAR2 = +##! M_SEARCH_DISABLED = YES diff --git a/documentation/test_doxygen/contents_blockquote/index.html b/documentation/test_doxygen/contents_blockquote/index.html new file mode 100644 index 00000000..350ff819 --- /dev/null +++ b/documentation/test_doxygen/contents_blockquote/index.html @@ -0,0 +1,33 @@ + + + + + My Project + + + + + +
+
+
+
+
+

+ My Project +

+

Mainly containing tests for Doxygen 1.9 parsing regressions and weirdness.

A blockquote. In 1.9 it has a ZWJ added in the XML, which should get stripped away again.

Preformatted text after a blockquote. In 1.9 it will get parsed just as a
+regular paragraph unless there's a dot before.
+

Another blockquote.

// code block that shouldn't be treated as inline
// quoted code block that should be neither inline nor in a paragraph

A delimiting paragraph, just to not have a blockqoute right after another blockquote.

Another blockquote.

"inline" + code in a usual paragraph.

Another blockquote.

"inline" + code with a tag after.

+
+
+
+
+ + diff --git a/documentation/test_doxygen/contents_blockquote/input.dox b/documentation/test_doxygen/contents_blockquote/input.dox new file mode 100644 index 00000000..c2607c29 --- /dev/null +++ b/documentation/test_doxygen/contents_blockquote/input.dox @@ -0,0 +1,32 @@ +/** @mainpage + +Mainly containing tests for Doxygen 1.9 parsing regressions and weirdness. + +> A blockquote. In 1.9 it has a ZWJ added in the XML, which should get stripped +> away again. + + Preformatted text after a blockquote. In 1.9 it will get parsed just as a + regular paragraph unless there's a dot before. + +> Another blockquote. + +@code{.cpp} +// code block that shouldn't be treated as inline +@endcode + +> @code{.cpp} +> // quoted code block that should be neither inline nor in a paragraph +> @endcode + +A delimiting paragraph, just to not have a blockqoute right after another +blockquote. + +> Another blockquote. + +@code{.cpp} "inline" + code @endcode in a usual paragraph. + +> Another blockquote. + +@code{.cpp} "inline" + code @endcode with a tag after. + +*/ diff --git a/documentation/test_doxygen/contents_typography/index.html b/documentation/test_doxygen/contents_typography/index.html index c06a0413..f1dccd1f 100644 --- a/documentation/test_doxygen/contents_typography/index.html +++ b/documentation/test_doxygen/contents_typography/index.html @@ -22,8 +22,8 @@

My Project

-

A blockquote.

Preformatted text.
-

Paragraph
with
explicit
line
breaks.

Page section

Differently
+
A blockquote.
Paragraph
with
explicit
line
breaks.
Preformatted text.
+
Page section
Differently
   preformatted
 text.
  • Unordered
  • list
  • of
    • nested
    • items
  • and back
  1. Ordered
  2. list
  3. of
    1. nested
    2. items
  4. and back
 This is a typewriter text, emphasis, bold. Emphasis with typewriter and bold nested. http://google.com and URL. Small text. En-dash – and em-dash —. Reference to a Page section. Named reference with special characters in title: » Warnings «. Reference with escaped characters in title: <anchor>.
2nd is L∞ ∀ ∇ π ℜ ℑ This costs no $, €, £, ¥ or ¤.
Empty elements:
Above is a horizontal line.

       
diff --git a/documentation/test_doxygen/contents_typography/input.dox b/documentation/test_doxygen/contents_typography/input.dox
index 61d53473..29c0cb80 100644
--- a/documentation/test_doxygen/contents_typography/input.dox
+++ b/documentation/test_doxygen/contents_typography/input.dox
@@ -2,10 +2,10 @@
 
 > A blockquote.
 
-    Preformatted text.
-
 Paragraph \n with \n explicit \n line \n breaks.
 
+    Preformatted text.
+
 @section section Page section
 
 
Differently
diff --git a/documentation/test_doxygen/test_contents.py b/documentation/test_doxygen/test_contents.py
index a505c867..debb41d7 100644
--- a/documentation/test_doxygen/test_contents.py
+++ b/documentation/test_doxygen/test_contents.py
@@ -504,3 +504,8 @@ class CodeFilters(IntegrationTestCase):
             }
         })
         self.assertEqual(*self.actual_expected_contents('index.html'))
+
+class Blockquote(IntegrationTestCase):
+    def test(self):
+        self.run_doxygen(wildcard='indexpage.xml')
+        self.assertEqual(*self.actual_expected_contents('index.html'))
-- 
2.30.2