mbox series

[FFmpeg-devel,0/3] Fix /// comments that should be ///<

Message ID 20240228171014.816489-1-ffmpeg-devel@pileofstuff.org
Headers show
Series Fix /// comments that should be ///< | expand

Message

Andrew Sayers Feb. 28, 2024, 5:09 p.m. UTC
This is the first in a planned series of patch series aimed at
fixing documentation issues, especially doxygen rendering.
I hope to post more as time allows in the coming days.

The first patch reflects the output of a `sed` command,
further patches fix edge cases not covered by `sed`.
Splitting commits this way allows merge conflicts
to be resolved by throwing the old commit away,
then running the command in the commit message.

Andrew Sayers (3):
      all: Fix /// comments that should be ///<
      avcodec/ivi: Make comments more Doxygen-friendly
      avcodec/avcodec: Downgrade multi-member comment to non-Doxygen comment

 libavcodec/avcodec.h     | 10 +++++-----
 libavcodec/bsf/noise.c   | 24 ++++++++++++------------
 libavcodec/ivi.h         | 15 +++++++--------
 libavfilter/vf_deshake.c |  2 +-
 libavformat/rmdec.c      |  4 ++--
 5 files changed, 27 insertions(+), 28 deletions(-)

Comments

Andreas Rheinhardt March 4, 2024, 4:49 p.m. UTC | #1
Stefano Sabatini:
> On date Wednesday 2024-02-28 17:09:38 +0000, Andrew Sayers wrote:
>> This is the first in a planned series of patch series aimed at
>> fixing documentation issues, especially doxygen rendering.
>> I hope to post more as time allows in the coming days.
>>
>> The first patch reflects the output of a `sed` command,
>> further patches fix edge cases not covered by `sed`.
>> Splitting commits this way allows merge conflicts
>> to be resolved by throwing the old commit away,
>> then running the command in the commit message.
>>
>> Andrew Sayers (3):
>>       all: Fix /// comments that should be ///<
>>       avcodec/ivi: Make comments more Doxygen-friendly
>>       avcodec/avcodec: Downgrade multi-member comment to non-Doxygen comment
>>
>>  libavcodec/avcodec.h     | 10 +++++-----
>>  libavcodec/bsf/noise.c   | 24 ++++++++++++------------
>>  libavcodec/ivi.h         | 15 +++++++--------
>>  libavfilter/vf_deshake.c |  2 +-
>>  libavformat/rmdec.c      |  4 ++--
>>  5 files changed, 27 insertions(+), 28 deletions(-)
> 
> Will apply, thanks.

Please don't. Anton intends to remove the pts_correction fields with the
bump and so this is unnecessary and will just cause a rebase conflict.

- Andreas