On Sun, Jul 03, 2011 at 09:12:19PM +0200, Reinhard Tartler wrote:
> On Sun, Jul 03, 2011 at 16:40:38 (CEST), Diego Biurrun wrote:
> 
> > On Sun, Jul 03, 2011 at 11:41:24AM +0200, Reinhard Tartler wrote:
> >> On Sat, Jul 02, 2011 at 14:50:44 (CEST), Diego Biurrun wrote:
> >> TBH, I'd rather remove the line, as the enum is already properly
> >> linkified at least in the html output.
> >
> > That would add another warning...
> 
> maybe we can turn them off in Doxyfile, then.

AFAIK we would have to turn off all warnings then.

> >> > --- a/libavfilter/graphparser.c
> >> > +++ b/libavfilter/graphparser.c
> >> > @@ -83,8 +83,8 @@ static char *parse_link_name(const char **buf, AVClass 
> >> > *log_ctx)
> >> >   * Create an instance of a filter, initialize and insert it in the
> >> >   * filtergraph in *ctx.
> >> >   *
> >> > + * @param filt_ctx put here a filter context in case of successful 
> >> > creation and configuration, NULL otherwise.
> >> >   * @param ctx the filtergraph context
> >> > - * @param put here a filter context in case of successful creation and 
> >> > configuration, NULL otherwise.
> >> >   * @param index an index which is supposed to be unique for each filter 
> >> > instance added to the filtergraph
> >> >   * @param filt_name the name of the filter to create
> >> >   * @param args the arguments provided to the filter during its 
> >> > initialization
> >> 
> >> Err, uh? I had to read the documentation string several times and still
> >> don't get it. Does a filt_ctx get created if NULL is passed? The
> >> function looks like an constructor to me, so in what cases wouldn't the
> >> user want to pass NULL here?
> >
> > Yes, the doxy could be improved, but I consider this out of the scope
> > of this patch.
> 
> bad/wrong documentation is worse than no documentation, imo

... next try ...

Diego
_______________________________________________
libav-devel mailing list
[email protected]
https://lists.libav.org/mailman/listinfo/libav-devel

Reply via email to