From: Vladimír Vondruš <mosra@centrum.cz>
Date: Mon, 29 Jan 2018 10:55:09 +0000 (+0100)
Subject: doxygen: support <pre> tags.
X-Git-Url: https://www.chiark.greenend.org.uk/ucgi/~cjwatson/git?a=commitdiff_plain;h=419fa8370bea7bad1b4946e798fcc4398eb00cc8;p=blog.git

doxygen: support <pre> tags.

I can't comprehend why there is a separate <verbatim> and
<preformatted> tag.
---

diff --git a/doxygen/dox2html5.py b/doxygen/dox2html5.py
index fee4c88b..07e4b62b 100755
--- a/doxygen/dox2html5.py
+++ b/doxygen/dox2html5.py
@@ -214,7 +214,7 @@ def parse_desc_internal(state: State, element: ET.Element, immediate_parent: ET.
         # - <heading>
         # - <blockquote>
         # - <simplesect> (if not describing return type) and <xrefsect>
-        # - <verbatim>
+        # - <verbatim>, <preformatted> (those are the same thing!)
         # - <variablelist>, <itemizedlist>, <orderedlist>
         # - <image>, <table>
         # - <mcss:div>
@@ -238,7 +238,7 @@ def parse_desc_internal(state: State, element: ET.Element, immediate_parent: ET.
             end_previous_paragraph = False
 
             # Straightforward elements
-            if i.tag in ['heading', 'blockquote', 'xrefsect', 'variablelist', 'verbatim', 'itemizedlist', 'orderedlist', 'image', 'table', '{http://mcss.mosra.cz/doxygen/}div']:
+            if i.tag in ['heading', 'blockquote', 'xrefsect', 'variablelist', 'verbatim', 'preformatted', 'itemizedlist', 'orderedlist', 'image', 'table', '{http://mcss.mosra.cz/doxygen/}div']:
                 end_previous_paragraph = True
 
             # <simplesect> describing return type is cut out of text flow, so
@@ -566,10 +566,10 @@ def parse_desc_internal(state: State, element: ET.Element, immediate_parent: ET.
 
             out.parsed += '</dl>'
 
-        elif i.tag == 'verbatim':
+        elif i.tag in ['verbatim', 'preformatted']:
             assert element.tag == 'para' # is inside a paragraph :/
             has_block_elements = True
-            out.parsed += '<pre class="m-code">{}</pre>'.format(html.escape(i.text))
+            out.parsed += '<pre>{}</pre>'.format(html.escape(i.text))
 
         elif i.tag == 'image':
             assert element.tag == 'para' # is inside a paragraph :/
diff --git a/doxygen/test/contents_typography/index.html b/doxygen/test/contents_typography/index.html
index 6341068b..8c1b5082 100644
--- a/doxygen/test/contents_typography/index.html
+++ b/doxygen/test/contents_typography/index.html
@@ -22,8 +22,10 @@
         <h1>
           My Project
         </h1>
-<section id="section"><h2><a href="#section">Page section</a></h2><blockquote><p>A blockquote.</p></blockquote><pre class="m-code">Preformatted text.
-</pre><p>Paragraph<br />with<br />explicit<br />line<br />breaks.</p><section id="subsection"><h3><a href="#subsection">Page subsection</a></h3><ul><li>Unordered</li><li>list</li><li>of<ul><li>nested</li><li>items</li></ul></li><li>and back</li></ul><section id="subsubsection"><h4><a href="#subsubsection">Sub-sub section</a></h4><ol><li>Ordered</li><li>list</li><li>of<ol><li>nested</li><li>items</li></ol></li><li>and back</li></ol><p><a name="an-anchor"></a> This is a <code>typewriter text</code>, <em>emphasis</em> and <strong>bold</strong>. <em>Emphasis with <code>typewriter</code> and <strong>bold</strong> nested.</em> <a href="http://google.com">http:/<wbr />/<wbr />google.com</a> and <a href="http://google.com">URL</a>. En-dash &ndash; and em-dash &mdash;. Reference to a <a href="index.html#subsection" class="m-dox">Page subsection</a>. Named reference with special characters in title: <a href="warnings.html" class="m-dox">&raquo; Warnings &laquo;</a>. Reference with escaped characters in&nbsp;title: <a href="index.html#an-anchor" class="m-dox">&lt;anchor&gt;</a>.</p></section></section></section>
+<section id="section"><h2><a href="#section">Page section</a></h2><blockquote><p>A blockquote.</p></blockquote><pre>Preformatted text.
+</pre><p>Paragraph<br />with<br />explicit<br />line<br />breaks.</p><pre>Differently
+  preformatted
+text.</pre><section id="subsection"><h3><a href="#subsection">Page subsection</a></h3><ul><li>Unordered</li><li>list</li><li>of<ul><li>nested</li><li>items</li></ul></li><li>and back</li></ul><section id="subsubsection"><h4><a href="#subsubsection">Sub-sub section</a></h4><ol><li>Ordered</li><li>list</li><li>of<ol><li>nested</li><li>items</li></ol></li><li>and back</li></ol><p><a name="an-anchor"></a> This is a <code>typewriter text</code>, <em>emphasis</em> and <strong>bold</strong>. <em>Emphasis with <code>typewriter</code> and <strong>bold</strong> nested.</em> <a href="http://google.com">http:/<wbr />/<wbr />google.com</a> and <a href="http://google.com">URL</a>. En-dash &ndash; and em-dash &mdash;. Reference to a <a href="index.html#subsection" class="m-dox">Page subsection</a>. Named reference with special characters in title: <a href="warnings.html" class="m-dox">&raquo; Warnings &laquo;</a>. Reference with escaped characters in&nbsp;title: <a href="index.html#an-anchor" class="m-dox">&lt;anchor&gt;</a>.</p></section></section></section>
       </div>
     </div>
   </div>
diff --git a/doxygen/test/contents_typography/input.dox b/doxygen/test/contents_typography/input.dox
index 33fc329e..c35d0ff3 100644
--- a/doxygen/test/contents_typography/input.dox
+++ b/doxygen/test/contents_typography/input.dox
@@ -8,6 +8,10 @@
 
 Paragraph \n with \n explicit \n line \n breaks.
 
+<pre>Differently
+  preformatted
+text.</pre>
+
 @subsection subsection Page subsection
 
 -   Unordered