[prev in list] [next in list] [prev in thread] [next in thread] 

List:       kde-devel
Subject:    Re: my first patch! (kdelibs)
From:       "Will Entriken" <kde.org () 2006 ! phor ! net>
Date:       2006-04-24 22:48:27
Message-ID: c0be00e90604241548m584ea783g583217207bd48fc9 () mail ! gmail ! com
[Download RAW message or body]

Here's another go at it. With more content.

-WE

On 4/24/06, Frans Englich <englich@kde.org> wrote:
> On Monday 24 April 2006 21:13, Will Entriken wrote:
> > for kdelibs. documents a function.
> >
> > did I do it right?
>
> Nice, I have some suggestions. This is how I would do it:
>
> * Doxygen provides a tag for setting off return values: "@return" or
> "@returns". So, one could write "@returns how reliable the answer is. The
> most reliable is shown first", and Doxygen would format it nicely. See:
> http://www.stack.nl/~dimitri/doxygen/commands.html#cmdreturn
>
> * I have a bit of trouble understanding the sentence. Perhaps it would be=
 more
> suitable to say "A larger value means higher reliability while a smaller
> value signals lower reliability."(or perhaps it is the reverse!). A
> description of what an "answer" is could eventually be suitable as well, =
but
> that belong perhaps in the class description.
>
>
> Cheers,
>
>                 Frans
>

["mysecondpatch.patch" (application/octet-stream)]

>> Visit http://mail.kde.org/mailman/listinfo/kde-devel#unsub to unsubscribe <<


[prev in list] [next in list] [prev in thread] [next in thread]