[FFmpeg-cvslog] avutil/channel_layout: Use inline code for Doxy

Marvin Scholz git at videolan.org
Mon Oct 17 11:01:19 EEST 2022


ffmpeg | branch: master | Marvin Scholz <epirat07 at gmail.com> | Sat Sep 24 22:06:50 2022 +0200| [f824388c335ab928021b1b4a0209c1946fd53207] | committer: Anton Khirnov

avutil/channel_layout: Use inline code for Doxy

This avoids Doxygen to interpret <i> and others that look like XML tags
as those, fixing a warning about unknown tags.

> http://git.videolan.org/gitweb.cgi/ffmpeg.git/?a=commit;h=f824388c335ab928021b1b4a0209c1946fd53207
---

 libavutil/channel_layout.h | 6 +++---
 1 file changed, 3 insertions(+), 3 deletions(-)

diff --git a/libavutil/channel_layout.h b/libavutil/channel_layout.h
index 29b8500e04..f023e144ec 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



More information about the ffmpeg-cvslog mailing list