[Note: Patch provided as an attachment to protect encoding/formatting.] The current official docs mistakenly pick up the override macros in libavcodec/tableprint_vlc.h as the canonical definitions of functions like av_free() and av_freep(), causing the docs to link to those #defines instead of the actual definitions of the functions (in libavutil/mem.c, for the examples given).
Wrapping the rogue macros in a conditional documentation section (arbitrarily named DOXYGEN_IGNORE), which is then NOT added to the ENABLED_SECTIONS config in the Doxyfile, is the recommended method of telling Doxygen to ignore some piece of code. Ref: https://www.doxygen.nl/manual/faq.html#faq_code Ref: https://www.doxygen.nl/manual/commands.html#cmdcond Signed-off-by: FeRD (Frank Dana) <ferd...@gmail.com>
From b7cce94eb92eccdd7b6d37770b4b994f8e3ef660 Mon Sep 17 00:00:00 2001 From: "FeRD (Frank Dana)" <ferd...@gmail.com> Date: Tue, 3 Jan 2023 00:29:02 -0500 Subject: [PATCH] Doxygen: Ignore tableprint_vlc.h defines The current official docs mistakenly pick up the override macros in libavcodec/tableprint_vlc.h as the canonical definitions of functions like av_free() and av_freep(), causing the docs to link to those #defines instead of the actual definitions of the functions (in libavutil/mem.c, for the examples given). Wrapping the rogue macros in a conditional documentation section (arbitrarily named DOXYGEN_IGNORE), which is then NOT added to the ENABLED_SECTIONS config in the Doxyfile, is the recommended method of telling Doxygen to ignore some piece of code. Ref: https://www.doxygen.nl/manual/faq.html#faq_code Ref: https://www.doxygen.nl/manual/commands.html#cmdcond Signed-off-by: FeRD (Frank Dana) <ferd...@gmail.com> --- libavcodec/tableprint_vlc.h | 2 ++ 1 file changed, 2 insertions(+) diff --git a/libavcodec/tableprint_vlc.h b/libavcodec/tableprint_vlc.h index b97c1f9cfb..ab32b91466 100644 --- a/libavcodec/tableprint_vlc.h +++ b/libavcodec/tableprint_vlc.h @@ -23,6 +23,7 @@ #ifndef AVCODEC_TABLEPRINT_VLC_H #define AVCODEC_TABLEPRINT_VLC_H +/** \cond DOXYGEN_IGNORE */ #define AVUTIL_LOG_H #define av_log(a, ...) while(0) #define ff_dlog(a, ...) while(0) @@ -34,6 +35,7 @@ #define av_freep(p) while(0) #define AVUTIL_INTERNAL_H #define avpriv_request_sample(...) +/** \endcond */ #include "tableprint.h" #include "vlc.h" #include "libavutil/reverse.c" -- 2.38.1
_______________________________________________ ffmpeg-devel mailing list ffmpeg-devel@ffmpeg.org https://ffmpeg.org/mailman/listinfo/ffmpeg-devel To unsubscribe, visit link above, or email ffmpeg-devel-requ...@ffmpeg.org with subject "unsubscribe".
