[Ffmpeg-devel] [PATCH]Doxygenize comments of libavutil/rationnal.h

[Dujardin Bernard]

Michael Niedermayer a ?crit :
> Hi
>
> argh i should have reviewed this more carefull
> 2nd try
>
>   
>> Index: rational.c
>> ===================================================================
>> --- rational.c	(revision 8131)
>> +++ rational.c	(working copy)
>> @@ -75,40 +75,24 @@
>>      return den==0;
>>  }
>>  
>> -/**
>> - * returns b*c.
>> - */
>>     
> [...]
>   
>>  
>> +/**
>> + * Multiply two rationals
>>     
>
> multiplieS two rationals
>
> also either make a sentence with upper case first letter and . at the end
> or neither (neither is what i would do and whats officially recommanded in
> javadoc IIRC)
>   
Applied, add other missed '.' in conformity with JAVADOC_AUTOBRIEF=YES 
in Doxyfile
>> +/**
>> + * Substract two rationals.
>> + * @param b first rational
>> + * @param c second rational
>> + * returns b-c.
>>     
>
> @
>   
Ok
>   
>> + */
>>  AVRational av_sub_q(AVRational b, AVRational c);
>> +
>> +/**
>> + * Converts a double precision floating point number to a rational.
>> + * @param d double to convert
>> + * @param max the maximum allowed numerator and denominator
>> + */
>>     
>
> no @returns
>   
See patch for @return comment.

Typo and other little correction like Adds instead Add in patch

Regards
Bernard
-------------- next part --------------
An embedded and charset-unspecified text was scrubbed...
Name: rational_h.patch
URL: <http://lists.mplayerhq.hu/pipermail/ffmpeg-devel/attachments/20070226/4c9464a6/attachment.txt>
-------------- next part --------------
An embedded and charset-unspecified text was scrubbed...
Name: rational_c.patch
URL: <http://lists.mplayerhq.hu/pipermail/ffmpeg-devel/attachments/20070226/4c9464a6/attachment.asc>