Re: [GnomeMeeting-devel-list] Doxygen documentation support [2]

[Damien Sandras <dsandras seconix com>]

Le samedi 22 avril 2006 à 14:03 +0200, Jose Carlos Garcia Sogo a écrit :
> El sáb, 22-04-2006 a las 13:59 +0200, Damien Sandras escribió:
> [...]
> > > 
> > >   Comments?
> > > 
> > 
> > The PRE should be kept in the documentation. 
> 
>   What is actually intention of PRE? Perhaps I have misinterpreted it.
> 

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
"
-- 
 _      Damien Sandras
(o-     
//\     Ekiga Softphone: http://www.ekiga.org/
v_/_    FOSDEM 2006    : http://www.fosdem.org/
        SIP Phone      : sip:dsandras ekiga net
                         sip:600000 ekiga net