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

[Michael Niedermayer]

Hi

On Mon, Feb 26, 2007 at 02:24:06PM +0100, Dujardin Bernard wrote:
> 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

looks ok

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

Everything should be made as simple as possible, but not simpler.
-- Albert Einstein
-------------- 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/5d24a7e5/attachment.pgp>