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 088994933C for ; Sat, 9 Mar 2024 16:06:43 +0000 (UTC) Received: from [127.0.1.1] (localhost [127.0.0.1]) by ffbox0-bg.mplayerhq.hu (Postfix) with ESMTP id C07A568CC8B; Sat, 9 Mar 2024 18:06:39 +0200 (EET) Received: from mail-wr1-f42.google.com (mail-wr1-f42.google.com [209.85.221.42]) by ffbox0-bg.mplayerhq.hu (Postfix) with ESMTPS id 6E23468B22E for ; Sat, 9 Mar 2024 18:06:33 +0200 (EET) Received: by mail-wr1-f42.google.com with SMTP id ffacd0b85a97d-33e742ca96bso2029268f8f.3 for ; Sat, 09 Mar 2024 08:06:33 -0800 (PST) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=gmail.com; s=20230601; t=1710000391; x=1710605191; 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=A/6J4skEQ6ybTfvt8IhLHBbnLkcVvEgM9P2vSl17CbE=; b=aR/aYb1HNhvWnD9wkdTf6nBGlkrtyWUG47QCbAxtlebkvvI6i8MNIXv5T9+mgCn5Gk 749bKH+o7UZiIsRcX3rDA3Tn+GBUTTFduxH31r1SFd8yMVSDJPOzJPF1d8O/5xqZFbp7 Y/l8FLDryJnnF1ig8B4pfwrHDKIrGvDQDpUYNMxSOXYqbwMC3t2P1RRhKpIoxME8xrDF MTwIdBr5X3UutjMG//n08RTvQUS69qno/k8j+XXwtHkQK2OO0uEAEVEzvqqfpsZCeoDk XVKb3/jokVxoQonNxVTS9KkTHIGFN+IrjWBTNHtN3UpwIUL4wx2YI6UyQJXiJN1mUWM7 p4Zg== X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20230601; t=1710000391; x=1710605191; 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=A/6J4skEQ6ybTfvt8IhLHBbnLkcVvEgM9P2vSl17CbE=; b=xLsBI37YWPhTdD/U84cLZsulQGhWnyHEb6jedvneVN12xUQR4lJEBwPAK0v0jjw76s 8uWtZxN9400YXyefWB7WUroZ8sUc5Y77hzrMN/j6Lip2H55ykn8aXhg4sWB68bBY3sDJ Wq6rSlokmXnaz8MNVhftKueNY106BuoAgyU/odfUzfR1DZEzCb4aWkTXPouV4qaFTarI kURTVefIQxQcECn+/tyPg28RDUuQ4MpsEzuDsJ/VH3F1PcZztsXCvN7HyV7JmFqaCCcq SXVvsDa4uz5Ongo3FNvLP/bevVjuyNtQZeTmHffCPOCh5CpJAAnGWXZD0vhdTBdfYcIN HkBw== X-Gm-Message-State: AOJu0Ywxysp8Ye277OVcoBg+OZOKzEGXwwH+kF7Bdw8rWI15MAf1uxdH aL3IIufDQ2asOPuz8fGX7kMNNig812p0ePEMzSX03nnkbzxRw4F4bnBLd+jv X-Google-Smtp-Source: AGHT+IGb18y9HUO/RohWDGL1wMGNdRKF/xFXk/I6fgq5pLbpBGxW7LVXYXSRMSZS1eIHfqFLQScHDA== X-Received: by 2002:a5d:6582:0:b0:33e:7869:fbcd with SMTP id q2-20020a5d6582000000b0033e7869fbcdmr1378856wru.53.1710000391089; Sat, 09 Mar 2024 08:06:31 -0800 (PST) Received: from mariano ([188.210.239.79]) by smtp.gmail.com with ESMTPSA id h6-20020adffa86000000b0033e7a499deasm2095630wrr.109.2024.03.09.08.06.30 (version=TLS1_3 cipher=TLS_AES_256_GCM_SHA384 bits=256/256); Sat, 09 Mar 2024 08:06:30 -0800 (PST) Received: by mariano (Postfix, from userid 1000) id 3A186BFCDC; Sat, 9 Mar 2024 17:06:28 +0100 (CET) Date: Sat, 9 Mar 2024 17:06:28 +0100 From: Stefano Sabatini To: FFmpeg development discussions and patches Message-ID: Mail-Followup-To: FFmpeg development discussions and patches , Andrew Sayers References: <20240229162424.850294-1-ffmpeg-devel@pileofstuff.org> <20240229162424.850294-2-ffmpeg-devel@pileofstuff.org> MIME-Version: 1.0 Content-Disposition: inline In-Reply-To: <20240229162424.850294-2-ffmpeg-devel@pileofstuff.org> User-Agent: Mutt/2.1.4 (2021-12-11) Subject: Re: [FFmpeg-devel] [PATCH 1/2] avformat: harmonise "- {decoding, encoding, demuxing, muxing}: " comments 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: Hi, sorry for the slow reply. On date Thursday 2024-02-29 16:23:06 +0000, Andrew Sayers wrote: > There seems to be a convention for documenting ownership: I find "ownership" a bit confusing, probably it's better to talk about context usage. > > /** > * - encoding: (who sets this in encoding context) > * - decoding: (who sets this in decoding context) > */ > int foo; > > Ensure all such comments start with a "-" and use lower case, > so doxygen formats them as a bulleted lists instead of one > long paragraph. > > Signed-off-by: Andrew Sayers > --- > libavformat/avformat.h | 67 +++++++++++++++++++++--------------------- > 1 file changed, 34 insertions(+), 33 deletions(-) > > diff --git a/libavformat/avformat.h b/libavformat/avformat.h > index f4506f4cf1..35b7f78ec7 100644 > --- a/libavformat/avformat.h > +++ b/libavformat/avformat.h > @@ -849,8 +849,8 @@ typedef struct AVStream { > int index; /**< stream index in AVFormatContext */ > /** > * Format-specific stream ID. > - * decoding: set by libavformat > - * encoding: set by the user, replaced by libavformat if left unset > + * - decoding: set by libavformat > + * - encoding: set by the user, replaced by libavformat if left unset > */ > int id; > > @@ -871,13 +871,13 @@ typedef struct AVStream { > * This is the fundamental unit of time (in seconds) in terms > * of which frame timestamps are represented. > * > - * decoding: set by libavformat > - * encoding: May be set by the caller before avformat_write_header() to > - * provide a hint to the muxer about the desired timebase. In > - * avformat_write_header(), the muxer will overwrite this field > - * with the timebase that will actually be used for the timestamps > - * written into the file (which may or may not be related to the > - * user-provided one, depending on the format). > + * - decoding: set by libavformat > + * - encoding: May be set by the caller before avformat_write_header() to > + * provide a hint to the muxer about the desired timebase. In > + * avformat_write_header(), the muxer will overwrite this field > + * with the timebase that will actually be used for the timestamps > + * written into the file (which may or may not be related to the > + * user-provided one, depending on the format). > */ > AVRational time_base; > > @@ -896,8 +896,9 @@ typedef struct AVStream { > * If a source file does not specify a duration, but does specify > * a bitrate, this value will be estimated from bitrate and file size. > * > - * Encoding: May be set by the caller before avformat_write_header() to > - * provide a hint to the muxer about the estimated duration. > + * - decoding: set by libavformat > + * - encoding: may be set by the caller before avformat_write_header() to > + * provide a hint to the muxer about the estimated duration. > */ > int64_t duration; > > @@ -935,8 +936,8 @@ typedef struct AVStream { > * For streams with AV_DISPOSITION_ATTACHED_PIC disposition, this packet > * will contain the attached picture. > * > - * decoding: set by libavformat, must not be modified by the caller. > - * encoding: unused > + * - decoding: set by libavformat, must not be modified by the caller. > + * - encoding: unused > */ > AVPacket attached_pic; > > @@ -1203,16 +1204,16 @@ typedef struct AVStreamGroup { > /** > * Group type-specific group ID. > * > - * decoding: set by libavformat > - * encoding: may set by the user > + * - decoding: set by libavformat > + * - encoding: may set by the user > */ > int64_t id; > > /** > * Group type > * > - * decoding: set by libavformat on group creation > - * encoding: set by avformat_stream_group_create() > + * - decoding: set by libavformat on group creation > + * - encoding: set by avformat_stream_group_create() > */ > enum AVStreamGroupParamsType type; > > @@ -1534,19 +1535,19 @@ typedef struct AVFormatContext { > > /** > * Forced video codec_id. > - * Demuxing: Set by user. > + * - demuxing: Set by user. while at it, probably we should use "decoding" in place of demuxing, since in this file "decoding" is semantically equivalent and used most prominently, same below [...] _______________________________________________ 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".