Fix: doc: escape double quote in bt_p alias
authorSimon Marchi <simon.marchi@efficios.com>
Thu, 11 Jan 2024 20:00:17 +0000 (15:00 -0500)
committerPhilippe Proulx <eeppeliteloop@gmail.com>
Tue, 23 Jan 2024 20:28:08 +0000 (15:28 -0500)
The HTML doc shows some `<span class=` where the parameter names are
meant to appear.  Escape those double quotes to fix it.

The output was correct in the past, it only started to display the wrong
thing with this commit, in Doxygen 1.9.0:

https://github.com/doxygen/doxygen/commit/eb3d1eb5ad85c94d6f2c32934fce2b8630331d6c

Reported-By: Brice Videau <bvideau@anl.gov>
Change-Id: I61f3b557e3d8bf1428dd57e4c1ce950461e32479
Signed-off-by: Simon Marchi <simon.marchi@efficios.com>
Reviewed-on: https://review.lttng.org/c/babeltrace/+/11647
Tested-by: jenkins <jenkins@lttng.org>
Reviewed-by: Philippe Proulx <eeppeliteloop@gmail.com>
(cherry picked from commit 95d759169cca3518352f539b6f87726b8cbb48e4)
Reviewed-on: https://review.lttng.org/c/babeltrace/+/11683
CI-Build: Philippe Proulx <eeppeliteloop@gmail.com>

doc/api/libbabeltrace2/Doxyfile.in

index cd94819eff482f84e913551e11374734dd8dd26e..07a7c2812d71e5fc990091d0f5b284c3db2004ca 100644 (file)
@@ -28,7 +28,7 @@ ALIASES                += bt_max_mip_version="0"
 ALIASES                += bt_name="Babeltrace&nbsp;2"
 ALIASES                += bt_name_version_min_maj="Babeltrace&nbsp;\bt_version_min_maj"
 ALIASES                += bt_api="Babeltrace&nbsp;2&nbsp;C&nbsp;API"
-ALIASES                += bt_p{1}="<span class="bt-param">\1</span>"
+ALIASES                += bt_p{1}="<span class=\"bt-param\">\1</span>"
 ALIASES                += bt_dt_opt="<strong><em>Optional</em></strong>:"
 ALIASES                += bt_man{2}="<a href=\"https://babeltrace.org/docs/v\bt_version_min_maj/man\2/\1.\2/\"><code><strong>\1</strong>(\2)</code></a>"
 ALIASES                += bt_cli="<a href=\"https://babeltrace.org/docs/v\bt_version_min_maj/man1/babeltrace2.1\"><code>babeltrace2</code></a>"
This page took 0.025389 seconds and 4 git commands to generate.