From patchwork Tue Jan 3 06:22:03 2023 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Frank Dana X-Patchwork-Id: 39834 Delivered-To: ffmpegpatchwork2@gmail.com Received: by 2002:a05:6a20:bc95:b0:ad:ade2:bfd2 with SMTP id fx21csp7838754pzb; Mon, 2 Jan 2023 22:22:41 -0800 (PST) X-Google-Smtp-Source: AMrXdXtNG0SlmbLZNeYZp378Js4yJj1ryYafui91ly/curkXOH76MNzdQ1ngGjCfhzIWo3InsHG7 X-Received: by 2002:a17:906:260e:b0:7c4:fe3c:cb2a with SMTP id h14-20020a170906260e00b007c4fe3ccb2amr37160510ejc.56.1672726960742; Mon, 02 Jan 2023 22:22:40 -0800 (PST) ARC-Seal: i=1; a=rsa-sha256; t=1672726960; cv=none; d=google.com; s=arc-20160816; b=tbZ6w5fqJGimy5oslzckTniPQAsGcJxJy7cisJt7HBq+pki5k7yuG4AkFuUANodFiD BCW/GeMgky2Rn5CTciLqQfe1JNM8yNuQg3ExkSN22SqPq/49GVDQpL9wOyY1s27z5GjK u/1kbccqwtXMIBQfqEwv/8dedikzVWF8reUCIprTE+5iiBoeDZjAq+mcpyH5/xhA93Qs Yw5Xvwb45ITRnVVpUyy9oJFaA/Z8StwHv9z8rt+GpgkH5Vm5EIdTsuxtScS05+0wTeEL gP02Scl0AsV42tl/Hya12mhKfvfS+HAsbhVtSDaolBMBVly9IHRRhOCk0IasssPNrY2h gC/A== ARC-Message-Signature: i=1; a=rsa-sha256; c=relaxed/relaxed; d=google.com; s=arc-20160816; h=sender:errors-to:reply-to:list-subscribe:list-help:list-post :list-archive:list-unsubscribe:list-id:precedence:subject:to :message-id:date:from:mime-version:dkim-signature:delivered-to; bh=lob5MGahClwpuHEm7hs6UFqp3cxFJM+Iv9iL8zEavTg=; b=M0aQBwY0W3btAGqc6iy4yE5s25+kOhCrs/yS8Ylp/5EI/nZqA2D1BotrKS307lWsno ASE2Wp8WDtt+0TrUGRx5q6njqWzK4R6tsjLmD5HoyXOUKQFPI+SY5GDNSXOGIvb1+lZ9 aD900LWBEdEn40GAAuo1gn+ueIypt1FbY3skg/9amiJYRCPbU+9JmFZ/Mr3c7rikDLe9 wtFoF5UbnTZwnpDfV09Brl2/fcF3gXYj4YRqHH93UoXTM0NPBxn6ErHA2TyLS+GdKSL1 Fm7sGkLS1M9rUP1NGVqkXGa/+5bmopko3rp8ySgvbeQTPgiGxeRP6jQPErvXHeEoxE8M tkWA== ARC-Authentication-Results: i=1; mx.google.com; dkim=neutral (body hash did not verify) header.i=@gmail.com header.s=20210112 header.b=W82QyO1E; spf=pass (google.com: domain of ffmpeg-devel-bounces@ffmpeg.org designates 79.124.17.100 as permitted sender) smtp.mailfrom=ffmpeg-devel-bounces@ffmpeg.org; dmarc=fail (p=NONE sp=QUARANTINE dis=NONE) header.from=gmail.com Return-Path: Received: from ffbox0-bg.mplayerhq.hu (ffbox0-bg.ffmpeg.org. [79.124.17.100]) by mx.google.com with ESMTP id hc30-20020a170907169e00b007c10bb4eaabsi30243632ejc.156.2023.01.02.22.22.40; Mon, 02 Jan 2023 22:22:40 -0800 (PST) Received-SPF: pass (google.com: domain of ffmpeg-devel-bounces@ffmpeg.org designates 79.124.17.100 as permitted sender) client-ip=79.124.17.100; Authentication-Results: mx.google.com; dkim=neutral (body hash did not verify) header.i=@gmail.com header.s=20210112 header.b=W82QyO1E; spf=pass (google.com: domain of ffmpeg-devel-bounces@ffmpeg.org designates 79.124.17.100 as permitted sender) smtp.mailfrom=ffmpeg-devel-bounces@ffmpeg.org; dmarc=fail (p=NONE sp=QUARANTINE dis=NONE) header.from=gmail.com Received: from [127.0.1.1] (localhost [127.0.0.1]) by ffbox0-bg.mplayerhq.hu (Postfix) with ESMTP id C473B68BCF7; Tue, 3 Jan 2023 08:22:37 +0200 (EET) X-Original-To: ffmpeg-devel@ffmpeg.org Delivered-To: ffmpeg-devel@ffmpeg.org Received: from mail-ej1-f50.google.com (mail-ej1-f50.google.com [209.85.218.50]) by ffbox0-bg.mplayerhq.hu (Postfix) with ESMTPS id 2ECB2680101 for ; Tue, 3 Jan 2023 08:22:31 +0200 (EET) Received: by mail-ej1-f50.google.com with SMTP id gh17so71415700ejb.6 for ; Mon, 02 Jan 2023 22:22:31 -0800 (PST) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=gmail.com; s=20210112; h=to:subject:message-id:date:from:mime-version:from:to:cc:subject :date:message-id:reply-to; bh=1fGI+GkIKc+k+YEw7QteZj4HLTla6pfM204qpdn5rpM=; b=W82QyO1EbZ5eGT1poDHAXDpYBtY74iYuLVGkVgykJlf3lgi1kZjbCOu++gSRK/TLX8 M+OewgifVOdzQuDAiOlNxr7Mh4eeXrwLsSdyaVJWfFltSnMJ5PBEVWbN3F8frjoDU0CB Hil8fJVCcEfdNuHlOjadlOKLAcebCqT45oNlHrEyz1ddAVA9M/NKpSWbpNKEW9R5Uefa 0mPR5VzIQZZG5JMc8iFptp+DyaMwcgZ31nLTb8O2XyL4Dsx9UhUtbV9pDJ0TlXcy0wcZ dpFQESs3nC4zmStwULVaX6Tq6h/8Cd6K7GTYT/uVaQQMuGLU0OC7xNjOdboiOBrjqchj 4SQw== X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20210112; h=to:subject:message-id:date:from:mime-version:x-gm-message-state :from:to:cc:subject:date:message-id:reply-to; bh=1fGI+GkIKc+k+YEw7QteZj4HLTla6pfM204qpdn5rpM=; b=nublvNF9cpS56mokkVdDBk51u/9uMjaygw/czwsxyna/NrDQ/07NnYRH3qCuMqNPkE YaH0B1xmHKw5FPOYurmnorn5Y8QKBUJS1OL9CiangIuVzQxXkhpioPgQ3dcUTNI7Iqec LHtwB8/G1Cr3FID25b/GDy2VmR7b39cEtH3N0rCslcufNcFHCyqkWqgGvK1BOVAIBeZM 0MsIsAi9F1xR2fv9uIHXx7RLlkqIQgAvkHMvMzK1CqfsZm+liCu6wsmlsp68O23FySEz MPEHvZ0Uxr6qIbIFMijf26xjYdwPntluq10J9r0+8QvW0PhE1d2vILT9YDd2JooX6YyM LgfA== X-Gm-Message-State: AFqh2krXl0GfkhxyC+zihYhyqQBpuRBtx+Ufkl2wpE71DSCNiHS1tE7g i6Lz7upaAnLyjDdWS0q8Mx9bs/69sQAHinFBY9TZW6SJJO1M+w== X-Received: by 2002:a17:906:cb85:b0:7ea:608f:23bd with SMTP id mf5-20020a170906cb8500b007ea608f23bdmr4600327ejb.221.1672726949509; Mon, 02 Jan 2023 22:22:29 -0800 (PST) MIME-Version: 1.0 From: Frank Dana Date: Tue, 3 Jan 2023 01:22:03 -0500 Message-ID: To: FFmpeg development discussions and patches X-Content-Filtered-By: Mailman/MimeDel 2.1.29 Subject: [FFmpeg-devel] [PATCH] Doxygen: Ignore tableprint_vlc.h defines X-BeenThere: ffmpeg-devel@ffmpeg.org X-Mailman-Version: 2.1.29 Precedence: list List-Id: FFmpeg development discussions and patches List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , Reply-To: FFmpeg development discussions and patches Errors-To: ffmpeg-devel-bounces@ffmpeg.org Sender: "ffmpeg-devel" X-TUID: itG/onoWVAND [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) From b7cce94eb92eccdd7b6d37770b4b994f8e3ef660 Mon Sep 17 00:00:00 2001 From: "FeRD (Frank Dana)" 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) --- 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