From mboxrd@z Thu Jan 1 00:00:00 1970 Return-Path: Received: from ffbox0-bg.mplayerhq.hu (ffbox0-bg.ffmpeg.org [79.124.17.100]) by master.gitmailbox.com (Postfix) with ESMTP id 4A3FA4A2EA for ; Mon, 29 Apr 2024 09:24:54 +0000 (UTC) Received: from [127.0.1.1] (localhost [127.0.0.1]) by ffbox0-bg.mplayerhq.hu (Postfix) with ESMTP id 971B968D495; Mon, 29 Apr 2024 12:24:27 +0300 (EEST) Received: from b-painless.mh.aa.net.uk (b-painless.mh.aa.net.uk [81.187.30.52]) by ffbox0-bg.mplayerhq.hu (Postfix) with ESMTPS id 319E268D3C5 for ; Mon, 29 Apr 2024 12:24:17 +0300 (EEST) Received: from 0.b.4.b.7.4.0.8.c.4.a.5.d.8.b.2.0.5.8.0.9.1.8.0.0.b.8.0.1.0.0.2.ip6.arpa ([2001:8b0:819:850:2b8d:5a4c:8047:b4b0] helo=andrews-2024-laptop.lan) by painless-b.tch.aa.net.uk with esmtp (Exim 4.96) (envelope-from ) id 1s1NFA-003PiE-25; Mon, 29 Apr 2024 10:24:16 +0100 From: Andrew Sayers To: ffmpeg-devel@ffmpeg.org Date: Mon, 29 Apr 2024 10:24:07 +0100 Message-ID: <20240429092407.2267590-4-ffmpeg-devel@pileofstuff.org> X-Mailer: git-send-email 2.43.0 In-Reply-To: <20240429092407.2267590-1-ffmpeg-devel@pileofstuff.org> References: <20240429092407.2267590-1-ffmpeg-devel@pileofstuff.org> MIME-Version: 1.0 Subject: [FFmpeg-devel] [PATCH v4 4/4] lavf: Add documentation for private "Context" classes 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 Cc: Andrew Sayers Content-Type: text/plain; charset="us-ascii" Content-Transfer-Encoding: 7bit Errors-To: ffmpeg-devel-bounces@ffmpeg.org Sender: "ffmpeg-devel" Archived-At: List-Archive: List-Post: Doxygen thinks any text like "Context for foo" is a link to a struct called "Context". Add a description and a better link, to avoid confusing readers. --- libavformat/async.c | 3 +++ libavformat/cache.c | 3 +++ 2 files changed, 6 insertions(+) diff --git a/libavformat/async.c b/libavformat/async.c index e096b0bc6f..3c28d418ae 100644 --- a/libavformat/async.c +++ b/libavformat/async.c @@ -53,6 +53,9 @@ typedef struct RingBuffer int read_pos; } RingBuffer; +/** + * @brief @ref md_doc_2context "Context" for testing async + */ typedef struct Context { AVClass *class; URLContext *inner; diff --git a/libavformat/cache.c b/libavformat/cache.c index 5f78adba9d..3cc0edec82 100644 --- a/libavformat/cache.c +++ b/libavformat/cache.c @@ -52,6 +52,9 @@ typedef struct CacheEntry { int size; } CacheEntry; +/** + * @brief @ref md_doc_2context "Context" for a cache + */ typedef struct Context { AVClass *class; int fd; -- 2.43.0 _______________________________________________ ffmpeg-devel mailing list ffmpeg-devel@ffmpeg.org https://ffmpeg.org/mailman/listinfo/ffmpeg-devel To unsubscribe, visit link above, or email ffmpeg-devel-request@ffmpeg.org with subject "unsubscribe".