[FFmpeg-devel] [PATCH] doc/eval: fix/extend documentation for root() function

[Stefano Sabatini]

On date Wednesday 2013-01-30 00:00:53 +0100, Michael Niedermayer encoded:
> On Sat, Jan 26, 2013 at 11:16:28AM +0100, Stefano Sabatini wrote:
[...]
> >  @item root(expr, max)
> > -Finds x where f(x)=0 in the interval 0..max.
> > -f() must be continuous or the result is undefined.
> > +Find a value where a function represented by @var{expr} with argument
> > + at var{ld(0)} is 0 in the interval 0.. at var{max}.
> > +
> > +The expression in @var{expr} must denote a continuous function or the
> > +result is undefined.
> > +
> 
> > + at var{ld(0)} is used to represent the function value, that means that
> 
> this is not correct
> you mix value and argument, maybe you should use "input" and "output"
> instead
> 
> 
> > +the given expression will be evaluated multiple times with various
> > +values of x that the expression can access through @code{ld(0)}. When
> > +the expression evaluates to 0 then the value of @code{ld(0)} will be
> > +returned.
> >  @end table

Up.
-- 
FFmpeg = Free and Forgiving Mere Perennial Ermetic Geek
-------------- next part --------------
A non-text attachment was scrubbed...
Name: 0001-doc-eval-fix-extend-documentation-for-root-function.patch
Type: text/x-diff
Size: 1283 bytes
Desc: not available
URL: <http://ffmpeg.org/pipermail/ffmpeg-devel/attachments/20130130/dcc74935/attachment.bin>