El sáb, 22-04-2006 a las 15:01 +0200, Damien Sandras escribió:
> Le samedi 22 avril 2006 à 14:03 +0200, Jose Carlos Garcia Sogo a écrit :
[...]
> The PREconditions on the argument. If they are not respected, then the
> function will break.
>
> Let's take the following function as example :
>
> double divide (double a, double b)
> {
> return a/b;
> }
>
> Here is bad documentation :
>
> "Returns a/b
> a, b are double
> "
>
> Here is good documentation :
>
> "Returns a/b
> a, b are double
> PRE: b !=0
> "
Which I think that could be translated to (doxygen "language"):
/**
* \brief Divides two numbers
* \param a Number to be divided
* \param b Divisor (must be !0)
*/
Cheers
--
Jose Carlos Garcia Sogo
jsogo debian org
Attachment:
signature.asc
Description: Esta parte del mensaje =?ISO-8859-1?Q?est=E1?= firmada digitalmente