chiark / gitweb /
documentation/doxygen: properly cover stripping links from code blocks.
authorVladimír Vondruš <mosra@centrum.cz>
Mon, 16 Sep 2024 17:51:05 +0000 (19:51 +0200)
committerVladimír Vondruš <mosra@centrum.cz>
Mon, 16 Sep 2024 17:51:05 +0000 (19:51 +0200)
This got broken when I was stripping down the tag file. Adding comments
in a hope that it won't break again.

doc/documentation/corrade.tag
documentation/test_doxygen/contents_tagfile/index-pygments29.html
documentation/test_doxygen/contents_tagfile/index.html
documentation/test_doxygen/contents_tagfile/input.dox

index a711b563ca6c062978185a12422bbcfeaee6a760..3a2f3015d8af74e60eda1acef419a0adc7bddd1d 100644 (file)
@@ -3,7 +3,8 @@
      corrade.tag generated for https://github.com/mosra/corrade, with
      everything needed by:
      - doc/plugins/links.rst
-     - plugins/m/test/dox/page.rst -->
+     - plugins/m/test/dox/page.rst
+     - documentation/test_doxygen/contents_tagfile/input.dox -->
 <tagfile>
   <compound kind="namespace">
     <name>Corrade::Utility::Path</name>
index 37cac36c4472d4155acf7d3b4813058dd6bbe8f5..60048eb33cde2ebd5f6edbd69454d318d9a773bf 100644 (file)
@@ -22,7 +22,7 @@
         <h1>
           My Project
         </h1>
-<p>See <a href="https://doc.magnum.graphics/corrade/Assert_8h.html#a83f7361970111951c88f1564a4f148e8" class="m-doc-external">CORRADE_<wbr />ASSERT()</a> for more information.</p><pre class="m-code"><span class="n">Corrade</span><span class="o">::</span><span class="n">Utility</span><span class="o">::</span><span class="n">Resource</span> <span class="n">rx</span><span class="p">;</span></pre>
+<p>See <a href="https://doc.magnum.graphics/corrade/Assert_8h.html#a83f7361970111951c88f1564a4f148e8" class="m-doc-external">CORRADE_<wbr />ASSERT()</a> for more information. The snippet below should have a link in the XML but not in the generated HTML (verifying it&#x27;s correctly stripped).</p><pre class="m-code"><span class="n">Corrade</span><span class="o">::</span><span class="n">Containers</span><span class="o">::</span><span class="n">String</span> <span class="n">s</span><span class="p">;</span></pre>
       </div>
     </div>
   </div>
index 1ff83c9be4737251a5879766653ab7a4e6d6ed03..f672827fb2f0e54efbc5e37cfb295d1ce388d7e0 100644 (file)
@@ -22,7 +22,7 @@
         <h1>
           My Project
         </h1>
-<p>See <a href="https://doc.magnum.graphics/corrade/Assert_8h.html#a83f7361970111951c88f1564a4f148e8" class="m-doc-external">CORRADE_<wbr />ASSERT()</a> for more information.</p><pre class="m-code"><span class="n">Corrade</span><span class="o">::</span><span class="n">Utility</span><span class="o">::</span><span class="n">Resource</span><span class="w"> </span><span class="n">rx</span><span class="p">;</span></pre>
+<p>See <a href="https://doc.magnum.graphics/corrade/Assert_8h.html#a83f7361970111951c88f1564a4f148e8" class="m-doc-external">CORRADE_<wbr />ASSERT()</a> for more information. The snippet below should have a link in the XML but not in the generated HTML (verifying it&#x27;s correctly stripped).</p><pre class="m-code"><span class="n">Corrade</span><span class="o">::</span><span class="n">Containers</span><span class="o">::</span><span class="n">String</span><span class="w"> </span><span class="n">s</span><span class="p">;</span></pre>
       </div>
     </div>
   </div>
index 9c3e3f5e47252cf06df765267397baa43d582ffe..d02526796c5d8cf0793d36c587612217dfe40cdb 100644 (file)
@@ -1,9 +1,11 @@
 /** @mainpage
 
-See @ref CORRADE_ASSERT() for more information.
+See @ref CORRADE_ASSERT() for more information. The snippet below should have a
+link in the XML but not in the generated HTML (verifying it's correctly
+stripped).
 
 @code{.cpp}
-Corrade::Utility::Resource rx;
+Corrade::Containers::String s;
 @endcode
 
 */