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

Michael Niedermayer michaelni
Mon Feb 26 12:16:04 CET 2007


Hi

argh i should have reviewed this more carefull
2nd try

On Mon, Feb 26, 2007 at 10:08:00AM +0100, Dujardin Bernard wrote:
> Guillaume Poirier a ?crit :
> >Hi,
> >
> >Michael Niedermayer wrote:
> >  
> >>On Sun, Feb 25, 2007 at 09:10:54PM +0100, Dujardin Bernard wrote:
> >>    
> >>>Attached a patch for $subj
> >>>      
> >>looks ok
> >>    
> Attached patch :
> 
> Update of my attached patch revision 8129 in answer to Micha?l
> 
> The patch move and update Doxygen comments from rational.c to rational.h
> At revision 8131

[...]

> 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)


> + * @param b first rationnal

typo nn

[...]
> +
> +/**
> + * Substract two rationals.
> + * @param b first rational
> + * @param c second rational
> + * returns b-c.

@


> + */
>  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

[...]
-- 
Michael     GnuPG fingerprint: 9FF2128B147EF6730BADF133611EC787040B0FAB

It is dangerous to be right in matters on which the established authorities
are wrong. -- Voltaire
-------------- next part --------------
A non-text attachment was scrubbed...
Name: not available
Type: application/pgp-signature
Size: 189 bytes
Desc: not available
URL: <http://lists.mplayerhq.hu/pipermail/ffmpeg-devel/attachments/20070226/dd2cb995/attachment.pgp>



More information about the ffmpeg-devel mailing list