diff mbox series

[FFmpeg-devel,v3,31/54] avutil/channel_layout: Use inline code for Doxy

Message ID 20220925001121.37721-32-epirat07@gmail.com
State Accepted
Commit f824388c335ab928021b1b4a0209c1946fd53207
Headers show
Series Various Doxygen fixes | expand

Checks

Context Check Description
andriy/make_x86 success Make finished
andriy/make_fate_x86 success Make fate finished

Commit Message

Marvin Scholz Sept. 25, 2022, 12:10 a.m. UTC 
This avoids Doxygen to interpret <i> and others that look like XML tags
as those, fixing a warning about unknown tags.
---
 libavutil/channel_layout.h | 6 +++---
 1 file changed, 3 insertions(+), 3 deletions(-)
diff mbox series

Patch

diff --git a/libavutil/channel_layout.h b/libavutil/channel_layout.h
index 6415355662..ee32cc9ab9 100644
--- a/libavutil/channel_layout.h
+++ b/libavutil/channel_layout.h
@@ -90,9 +90,9 @@  enum AVChannel {
      * Range of channels between AV_CHAN_AMBISONIC_BASE and
      * AV_CHAN_AMBISONIC_END represent Ambisonic components using the ACN system.
      *
-     * Given a channel id <i> between AV_CHAN_AMBISONIC_BASE and
-     * AV_CHAN_AMBISONIC_END (inclusive), the ACN index of the channel <n> is
-     * <n> = <i> - AV_CHAN_AMBISONIC_BASE.
+     * Given a channel id `<i>` between AV_CHAN_AMBISONIC_BASE and
+     * AV_CHAN_AMBISONIC_END (inclusive), the ACN index of the channel `<n>` is
+     * `<n> = <i> - AV_CHAN_AMBISONIC_BASE`.
      *
      * @note these values are only used for AV_CHANNEL_ORDER_CUSTOM channel
      * orderings, the AV_CHANNEL_ORDER_AMBISONIC ordering orders the channels