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 E5AE74AE86 for ; Wed, 22 May 2024 10:08:41 +0000 (UTC) Received: from [127.0.1.1] (localhost [127.0.0.1]) by ffbox0-bg.mplayerhq.hu (Postfix) with ESMTP id BAD8068D410; Wed, 22 May 2024 13:08:38 +0300 (EEST) Received: from mail-ed1-f44.google.com (mail-ed1-f44.google.com [209.85.208.44]) by ffbox0-bg.mplayerhq.hu (Postfix) with ESMTPS id 08E4F68D119 for ; Wed, 22 May 2024 13:08:32 +0300 (EEST) Received: by mail-ed1-f44.google.com with SMTP id 4fb4d7f45d1cf-572af0b12b8so9674661a12.2 for ; Wed, 22 May 2024 03:08:31 -0700 (PDT) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=gmail.com; s=20230601; t=1716372511; x=1716977311; darn=ffmpeg.org; h=user-agent:in-reply-to:content-disposition:mime-version:references :mail-followup-to:message-id:subject:cc:to:from:date:from:to:cc :subject:date:message-id:reply-to; bh=EBhFEVxp98E6KGwsskNctIaHVtIy7/uKK9O+0Kt5hmg=; b=SJxSmlQbcYVlr9suyPp6q9Iw1iJs/buGOERXUUBz0PA+uTonVrVYW0F5Gn/ZQVzc1l M9HmuFvw4KFEqbwYs1ouDN7pf22TdWnLyvGLLnutBbU0FdxJXFlV/O7i9wgdSk0G74k6 /8xKZpIaPOhVKqagyNeP5ZXjJDP9uWYpGeV7KaRtbLENvGEj9Hq93HgX7JjN5AHPAykZ g3LQy/vB4FbN5c7Fz/glkYXbI/WVxMq/yDiWOVEIeO3Gy+kUtbMUKo1EZLKLuVq2O3bx xNrHN7ps3IjrdlcobwtYPBUmPw0CczqYPrUShj/g3E6OALpFvEzXaUkAuXtEpOHewWGk VtPQ== X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20230601; t=1716372511; x=1716977311; h=user-agent:in-reply-to:content-disposition:mime-version:references :mail-followup-to:message-id:subject:cc:to:from:date :x-gm-message-state:from:to:cc:subject:date:message-id:reply-to; bh=EBhFEVxp98E6KGwsskNctIaHVtIy7/uKK9O+0Kt5hmg=; b=rTkPEBMiJ5PihoifzwuTJ26c3kvB1ROibgtVR9z0irz/i+sRwfNzbqZX1bpXoxCdTB i/UpvOhFHF+JUHdpNS8heGmEDGri2E94rkIvIass71n7cj6cHpAKTnwr0Vmhil6WND9G K1yTOKhA65SKxJxKm13FFVu18OgrdHTcA6X1iGylGGNuiUKPU95GJxEzEJfWXngYXVc6 Rvj5E0f0T+iudz3OLX7Mfw5sMJXYTNyO1I8WAmjz7aqdT6Gikq+MIiFTNXcdqaCGTM7o 5oyxEjmiJgA+/iRDYEwb/ykScZLmt1Ewnyru9ZwcFHfjYL0KmVWfmzr/RSOwat664JPH g+9A== X-Gm-Message-State: AOJu0YwMVwWGNmpbDhJMtx9dkeVgng4u5F7iIsrGyAAAZQLkmaVUIwVq ++QMiJAUjETIXZt2+aZFkQVunQpzT1pcm7arGT4CiZb9+CGQKhLP6OUbFQ== X-Google-Smtp-Source: AGHT+IFdZaSTXmv8VNP2K++94SzMWX9sHsyBanGqbyA8Du5/9i13WMU+BGYA8grHvpgBtbtMPeOwfA== X-Received: by 2002:a17:906:1d02:b0:a5a:50e4:5738 with SMTP id a640c23a62f3a-a6228191db9mr100793266b.73.1716372510768; Wed, 22 May 2024 03:08:30 -0700 (PDT) Received: from mariano (dynamic-adsl-84-220-189-10.clienti.tiscali.it. [84.220.189.10]) by smtp.gmail.com with ESMTPSA id a640c23a62f3a-a5a1781d787sm1784249566b.11.2024.05.22.03.08.30 (version=TLS1_3 cipher=TLS_AES_256_GCM_SHA384 bits=256/256); Wed, 22 May 2024 03:08:30 -0700 (PDT) Received: by mariano (Postfix, from userid 1000) id 5F166BFCE8; Wed, 22 May 2024 12:08:29 +0200 (CEST) Date: Wed, 22 May 2024 12:08:29 +0200 From: Stefano Sabatini To: FFmpeg development discussions and patches Message-ID: Mail-Followup-To: FFmpeg development discussions and patches , Andrew Sayers References: <20240418150614.3952107-1-ffmpeg-devel@pileofstuff.org> <20240515155446.3589239-1-ffmpeg-devel@pileofstuff.org> <20240515155446.3589239-5-ffmpeg-devel@pileofstuff.org> MIME-Version: 1.0 Content-Disposition: inline In-Reply-To: <20240515155446.3589239-5-ffmpeg-devel@pileofstuff.org> User-Agent: Mutt/2.1.4 (2021-12-11) Subject: Re: [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: On date Wednesday 2024-05-15 16:54:22 +0100, Andrew Sayers wrote: > 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; Not sure, these are private structs and we enforce no use of internal markup for those, and we can assume internals developers are already acquainted with contexts and such so this is probably adding no value. _______________________________________________ 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".