From mboxrd@z Thu Jan  1 00:00:00 1970
Return-Path: <ffmpeg-devel-bounces@ffmpeg.org>
Received: from ffbox0-bg.mplayerhq.hu (ffbox0-bg.ffmpeg.org [79.124.17.100])
	by master.gitmailbox.com (Postfix) with ESMTP id D7E374A9D2
	for <ffmpegdev@gitmailbox.com>; Sat,  6 Jul 2024 10:41:43 +0000 (UTC)
Received: from [127.0.1.1] (localhost [127.0.0.1])
	by ffbox0-bg.mplayerhq.hu (Postfix) with ESMTP id D6B5D68DBC4;
	Sat,  6 Jul 2024 13:41:38 +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 547E468DBBF
 for <ffmpeg-devel@ffmpeg.org>; Sat,  6 Jul 2024 13:41:32 +0300 (EEST)
Received: from
 2.d.8.9.0.5.1.6.6.d.8.f.2.0.a.e.0.5.8.0.9.1.8.0.0.b.8.0.1.0.0.2.ip6.arpa
 ([2001:8b0:819:850:ea02:f8d6:6150:98d2] helo=andrews-2024-laptop.sayers)
 by painless-b.tch.aa.net.uk with smtp (Exim 4.96)
 (envelope-from <ffmpeg-devel@pileofstuff.org>) id 1sQ2rB-001p32-1m
 for ffmpeg-devel@ffmpeg.org; Sat, 06 Jul 2024 11:41:31 +0100
Date: Sat, 6 Jul 2024 11:41:24 +0100
From: Andrew Sayers <ffmpeg-devel@pileofstuff.org>
To: FFmpeg development discussions and patches <ffmpeg-devel@ffmpeg.org>
Message-ID: <ZokfVEA7yHzeUGEa@andrews-2024-laptop.sayers>
References: <ZoMuv89bLCVPsMWf@mariano>
 <20240702090917.319956-1-ffmpeg-devel@pileofstuff.org>
 <ZokQTzkL6ZqI/c3g@mariano>
MIME-Version: 1.0
Content-Disposition: inline
In-Reply-To: <ZokQTzkL6ZqI/c3g@mariano>
Subject: Re: [FFmpeg-devel] [PATCH v4 0/3] s/RUNTIME/POST_INIT_SETTABLE/
X-BeenThere: ffmpeg-devel@ffmpeg.org
X-Mailman-Version: 2.1.29
Precedence: list
List-Id: FFmpeg development discussions and patches <ffmpeg-devel.ffmpeg.org>
List-Unsubscribe: <https://ffmpeg.org/mailman/options/ffmpeg-devel>,
 <mailto:ffmpeg-devel-request@ffmpeg.org?subject=unsubscribe>
List-Archive: <https://ffmpeg.org/pipermail/ffmpeg-devel>
List-Post: <mailto:ffmpeg-devel@ffmpeg.org>
List-Help: <mailto:ffmpeg-devel-request@ffmpeg.org?subject=help>
List-Subscribe: <https://ffmpeg.org/mailman/listinfo/ffmpeg-devel>,
 <mailto:ffmpeg-devel-request@ffmpeg.org?subject=subscribe>
Reply-To: FFmpeg development discussions and patches <ffmpeg-devel@ffmpeg.org>
Content-Type: text/plain; charset="us-ascii"
Content-Transfer-Encoding: 7bit
Errors-To: ffmpeg-devel-bounces@ffmpeg.org
Sender: "ffmpeg-devel" <ffmpeg-devel-bounces@ffmpeg.org>
Archived-At: <https://master.gitmailbox.com/ffmpegdev/ZokfVEA7yHzeUGEa@andrews-2024-laptop.sayers/>
List-Archive: <https://master.gitmailbox.com/ffmpegdev/>
List-Post: <mailto:ffmpegdev@gitmailbox.com>

On Sat, Jul 06, 2024 at 11:37:19AM +0200, Stefano Sabatini wrote:
> On date Tuesday 2024-07-02 10:08:37 +0100, Andrew Sayers wrote:
[...]
> While I agree with Anton that we should avoid duplication, for the
> usual arguments that a reference should avoid duplication of content
> as much as possible, which inevitably leads to inconsistent content
> when it is updated partially, leading to inconsistent information.

I think we're mostly just bikeshedding about how to balance discoverability
with duplication, but feel obliged to point out a third option.  Our Doxygen
config has MACRO_EXPANSION enabled both in the repo and on the site,
so we can use macros to avoid duplicating documentation:

    #define BOILERPLATE \
      /** Lorem ipsum dolor sit amet, consectetur adipiscing elit */
    
    /**
     * @brief Main function
     *
     */
    BOILERPLATE
    int main() {}

I think that's too weird a hack, but happy to propose a patch if you disagree.
_______________________________________________
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".