[FFmpeg-devel] [PATCH] ff* tools: move descriptions from copyright header to @file doxy

[Stefano Sabatini]

On date Monday 2011-12-26 00:30:33 +0100, Clément Bœsch encoded:
> On Fri, Dec 23, 2011 at 11:19:57AM +0100, Stefano Sabatini wrote:
> > On date Thursday 2011-12-22 12:38:36 +0100, Clément Bœsch encoded:
> > > On Thu, Dec 22, 2011 at 11:09:35AM +0100, Stefano Sabatini wrote:
> > > > ---
> > > >  ffmpeg.c   |    6 +++++-
> > > >  ffplay.c   |    6 +++++-
> > > >  ffprobe.c  |    6 +++++-
> > > >  ffserver.c |    6 +++++-
> > > >  4 files changed, 20 insertions(+), 4 deletions(-)
> > > > 
> > > > diff --git a/ffmpeg.c b/ffmpeg.c
> > > > index 75274db..e72dfcb 100644
> > > > --- a/ffmpeg.c
> > > > +++ b/ffmpeg.c
> > > > @@ -1,5 +1,4 @@
> > > >  /*
> > > > - * ffmpeg main
> > > >   * Copyright (c) 2000-2003 Fabrice Bellard
> > > >   *
> > > >   * This file is part of FFmpeg.
> > > > @@ -19,6 +18,11 @@
> > > >   * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
> > > >   */
> > > >  
> > > > +/**
> > > > + * @file
> > > > + * ffmpeg main
> > > > + */
> > > > +
> > > 
> > > I guess it's OK, but maybe take the opportunity to write a better
> > > description?
> > 
> > Updated with some consistency nits addressed.
> > -- 
> > FFmpeg = Fundamental and Friendly Mean Pitiless Elitist Gem
> 
> > From 055460600992c0098fb30a1ec0e8302ea5dabe48 Mon Sep 17 00:00:00 2001
> > From: Stefano Sabatini <stefasab at gmail.com>
> > Date: Thu, 22 Dec 2011 10:23:22 +0100
> > Subject: [PATCH] ff* tools: move descriptions from copyright header to @file
> >  doxy
> > 
> > ---
> >  ffmpeg.c   |    6 +++++-
> >  ffplay.c   |    6 +++++-
> >  ffprobe.c  |    6 +++++-
> >  ffserver.c |    6 +++++-
> >  4 files changed, 20 insertions(+), 4 deletions(-)
> > 
> > diff --git a/ffmpeg.c b/ffmpeg.c
> > index a05b2fc..cee5233 100644
> > --- a/ffmpeg.c
> > +++ b/ffmpeg.c
> > @@ -1,5 +1,4 @@
> >  /*
> > - * ffmpeg main
> >   * Copyright (c) 2000-2003 Fabrice Bellard
> >   *
> >   * This file is part of FFmpeg.
> > @@ -19,6 +18,11 @@
> >   * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
> >   */
> >  
> > +/**
> > + * @file
> > + * multimedia converter converter based on the FFmpeg libraries
> 
> Maybe add a third "converter" in case the convert is symmetric.

Any number belonging to a Fibonacci sequence was fine (not for a
specific reason, but because we like Fibonacci sequences), so I ended
up choosing 1.

> 
> Note: we may want to update the descriptions in show_usage() functions to
> match the new doxy ones.

If you feel like so...

Patch applied.
-- 
FFmpeg = Free and Funny Marvellous Proud Elitarian Gadget