[Ffmpeg-devel] [PATCH] av_log Doxygen docs

[Panagiotis Issaris]

Hi,

Michel Bardiaux schreef:
> Panagiotis Issaris wrote:
> [snip]
>>  
>> +/**
>> + * Send the specified message to the log if the level is higher than 
>> the current
>
> ... level is higher than or equal to ...
You are right, fixed.

>> + * av_log_level. By default, all logging messages are sent to 
>> stderr. This
>> + * behavior can be altered by setting a different av_vlog callback 
>> function.
>> + *
>> + * @param avcl The AVClass which provides context for the message
>
> No, you pass the address of any structure which has an AVClass* as 
> first field. Currently, an AVCodecContext* or AVFormatContext*.
Oh, I figured it was a bit OO-inheritance like and had shortened the 
following into the above:
"The instance of AVClass which provides the context for the message."

Do you agree with the unshortened version, or do you think the 
shortening was not the problem?


>> + * @param level The importance level of the message
>
> Actually, level=0 is PANIC and 48 is DEBUG, so it is a level of 
> *un*importance.
 61  * @param level The importance level of the message, 0 being the 
highest level.
 61  * @param level The importance level of the message, lower values 
signifying higher importance.
 61  * @param level The unimportance level of the message.
Which of the above would be best? Personally, I prefer the second and 
dislike the third, simply because it seems
strange to me to have an unimportance level.


>
>> + * @param fmt The format string that specifies how subsequent 
>> arguments are
>
> Maybe "The format string (printf-compatible) that...".
Thanks! Fixed.

>> + * converted to output.
>> + * @see av_vlog
>> + */
>

Thanks for reviewing!


 log.c |   13 +++++++++++++
 1 file changed, 13 insertions(+)

With friendly regards,
Takis
-------------- next part --------------
A non-text attachment was scrubbed...
Name: pi-20070219T192737-ffmpeg-av_log_dox2.diff
Type: text/x-patch
Size: 937 bytes
Desc: not available
URL: <http://lists.mplayerhq.hu/pipermail/ffmpeg-devel/attachments/20070219/a334d4fa/attachment.bin>