From 57dc7baff0e3e661f196fbdfd4dbf9044de45835 Mon Sep 17 00:00:00 2001 From: =?utf8?q?Vladim=C3=ADr=20Vondru=C5=A1?= Date: Mon, 16 Sep 2024 19:51:05 +0200 Subject: [PATCH] documentation/doxygen: properly cover stripping links from code blocks. 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 | 3 ++- .../test_doxygen/contents_tagfile/index-pygments29.html | 2 +- documentation/test_doxygen/contents_tagfile/index.html | 2 +- documentation/test_doxygen/contents_tagfile/input.dox | 6 ++++-- 4 files changed, 8 insertions(+), 5 deletions(-) diff --git a/doc/documentation/corrade.tag b/doc/documentation/corrade.tag index a711b563..3a2f3015 100644 --- a/doc/documentation/corrade.tag +++ b/doc/documentation/corrade.tag @@ -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 --> Corrade::Utility::Path diff --git a/documentation/test_doxygen/contents_tagfile/index-pygments29.html b/documentation/test_doxygen/contents_tagfile/index-pygments29.html index 37cac36c..60048eb3 100644 --- a/documentation/test_doxygen/contents_tagfile/index-pygments29.html +++ b/documentation/test_doxygen/contents_tagfile/index-pygments29.html @@ -22,7 +22,7 @@

My Project

-

See CORRADE_ASSERT() for more information.

Corrade::Utility::Resource rx;
+

See 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).

Corrade::Containers::String s;
diff --git a/documentation/test_doxygen/contents_tagfile/index.html b/documentation/test_doxygen/contents_tagfile/index.html index 1ff83c9b..f672827f 100644 --- a/documentation/test_doxygen/contents_tagfile/index.html +++ b/documentation/test_doxygen/contents_tagfile/index.html @@ -22,7 +22,7 @@

My Project

-

See CORRADE_ASSERT() for more information.

Corrade::Utility::Resource rx;
+

See 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).

Corrade::Containers::String s;
diff --git a/documentation/test_doxygen/contents_tagfile/input.dox b/documentation/test_doxygen/contents_tagfile/input.dox index 9c3e3f5e..d0252679 100644 --- a/documentation/test_doxygen/contents_tagfile/input.dox +++ b/documentation/test_doxygen/contents_tagfile/input.dox @@ -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 */ -- 2.30.2