[FFmpeg-devel] [PATCH 1/2] Prettify eval.h doxy.

[Stefano Sabatini]

On date Tuesday 2010-06-01 21:43:50 +0200, Michael Niedermayer encoded:
> On Tue, Jun 01, 2010 at 06:45:06PM +0200, Stefano Sabatini wrote:
> > On date Tuesday 2010-06-01 17:54:46 +0200, Michael Niedermayer encoded:
> > > On Tue, Jun 01, 2010 at 05:25:05PM +0200, Stefano Sabatini wrote:
> > > > On date Tuesday 2010-06-01 16:43:58 +0200, Michael Niedermayer encoded:
> > > > > On Tue, Jun 01, 2010 at 10:26:01AM +0200, Stefano Sabatini wrote:
> > > > [...]
> > > > > should be:
> > > > > 
> > > > > > - * @param s            expression as a zero terminated string for example "1+2^3+5*5+sin(2/3)"
> > > > > > - * @param const_names  NULL terminated array of zero terminated strings of constant identifers for example {"PI", "E", 0}
> > > > > > - * @param const_values a zero terminated array of values for the identifers from const_names
> > > > > > - * @param func1_names  NULL terminated array of zero terminated strings of funcs1 identifers
> > > > > > - * @param funcs1       NULL terminated array of function pointers for functions which take 1 argument
> > > > > > - * @param func2_names  NULL terminated array of zero terminated strings of funcs2 identifers
> > > > > > - * @param funcs2       NULL terminated array of function pointers for functions which take 2 arguments
> > > > > > - * @param opaque       a pointer which will be passed to all functions from funcs1 and funcs2
> > > > > 
> > > 
> > > > > anyway, all break at 80 column blindy changes are rejected
> > > > 
> > > > Updated.
> > > 
> > > no
> > 
> > Again. Please let's try to bikeshed / waste time on this,
> 
> if you insist
> 
> 
> > give clear
> > indications and I'll try to follow them, while trying to avoid overly
> > long lines at the same time.
> 
> with 1 line "things" the fact that each line is one "thing" provides
> adequate seperation
> with multiline "things" another form of seperation is needed or this becomes
> a bit spagethi like.
> the empty space in the first columns helps a bit but i think
> that maybe empty lines would help more

As you may guess I'm also concerned about the consistency with the
rest of the doxies, I don't want to end up with each file showing a
different style, so while I can tolerate long lines and vertical
@param alignment I'd prefer to avoid other forms of separation between
params seen nowhere else in the docs.

Anyway, since I don't want to waste more time on this, feel free to
fetch the patch, edit and apply it yourself, or just give me the OK
and I'll apply it as it is.

Regards.
-- 
FFmpeg = Free & Fostering MultiPurpose Erratic God