diff mbox series

[FFmpeg-devel,v2,7/7] avcodec/avcodec: Escape Doxygen reference

Message ID 20220922020400.46715-7-epirat07@gmail.com
State Superseded
Headers show
Series [FFmpeg-devel,v2,1/7] avcodec: Fix Doxygen trailing brief comments | expand

Checks

Context Check Description
andriy/configure_x86 warning Failed to run configure
yinshiyou/make_loongarch64 success Make finished
yinshiyou/make_fate_loongarch64 success Make fate finished

Commit Message

Marvin Scholz Sept. 22, 2022, 2:04 a.m. UTC
The # is interpreted as explicit reference request by Doxygen
which is not desired here.

Additionally use a typewriter font to make the inline code
easier to distinguish.
---
 libavcodec/avcodec.h | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)
diff mbox series

Patch

diff --git a/libavcodec/avcodec.h b/libavcodec/avcodec.h
index 665a5eadaf..f0904520b1 100644
--- a/libavcodec/avcodec.h
+++ b/libavcodec/avcodec.h
@@ -1518,7 +1518,7 @@  typedef struct AVCodecContext {
      *   libavcodec will behave as if this field was always set to 1.
      *   Callers that want to be forward compatible with future libavcodec
      *   versions should wrap access to this field in
-     *     #if LIBAVCODEC_VERSION_MAJOR < 60
+     *     <tt>\#if LIBAVCODEC_VERSION_MAJOR < 60</tt>
      */
     attribute_deprecated
     int thread_safe_callbacks;