[FFmpeg-devel] [PATCH] Doxygenate libavutil/mem.h

[Stefano Sabatini]

On date Saturday 2007-09-22 12:26:57 +0200, Michael Niedermayer encoded:
[...]
> rejected!
> 
> ive said it in the past and i say it again, the doxygen comments in teh
> headers document the API they do NOT document the implementation behavior
> 
> this is not a little cosmetic issue, if you say X there it means we must
> do X unless we bump the major version number
> simply saying we do what implementation Y does is sick, what if 2 versions
> of Y do something else? what if Y violates the c spec?
> 
> please DO NOT document what the current implementation does in the
> headers this is INAPPROPRIATE!
> document what it should do if its free of bugs and do it in the most
> generic way possible
> 
> for example:
> wrong:
> @param datestr String representing a date or a duration.
> - If a date the syntax is:
> [{YYYY-MM-DD|YYYYMMDD}]{T| }{HH[:MM[:SS[.m...]]][Z]|HH[MM[SS[.m...]]][Z]}
> 
> correct:
> @param datestr String representing a date or a duration.
> parse_date supports various forms currently supported is:
> [{YYYY-MM-DD|YYYYMMDD}]{T| }{HH[:MM[:SS[.m...]]][Z]|HH[MM[SS[.m...]]][Z]}
> future versions might add further variants

Hi Michael, 

yes you're completely right, now I see how silly it was.

I amended the previous patch eliminating in the av_realloc
documentation all the references to other functions implementations,
hope it is now more correct.

Regards.
-- 
Stefano Sabatini
Linux user number 337176 (see http://counter.li.org)
-------------- next part --------------
A non-text attachment was scrubbed...
Name: doxygenate-mem-h-04.patch
Type: text/x-diff
Size: 2558 bytes
Desc: not available
URL: <http://lists.mplayerhq.hu/pipermail/ffmpeg-devel/attachments/20070922/c6c751fb/attachment.patch>