[Kde-pim] kdepimlibs APIDOX

[Allen Winter]

On Tuesday 11 September 2007 1:32:28 pm Mike Arthur wrote:
> On Monday 10 September 2007 14:02:42 Allen Winter wrote:
> > Please don't forget to write apidox for your libs in kdepimlibs [1]
> >
> > It isn't surprising that some of our older libs like kcal and kabc
> > have  missing dox, but please give some love to our new libs
> > like kblog and kldap.
> With getter/setter methods where the return/sole param will just be a copy and 
> paste of the method description do you need to add the return or param value 
> or is it ok to omit it?
> 

With getter methods don't use @return; the redundancy is annoying I think.
I typically write something like:
/**
  Returns the weight of the critter.
*/

With setter methods I use the @param simply because our doxygen setup
will bitch if each parameter isn't documented.  The @param is sometimes
useful anyhow, like so:

/**
   Sets the critter @p weight.
   @param weight is a non-negative integer as computed by critterWeight().
*/

_______________________________________________
KDE PIM mailing list kde-pim at kde.org
https://mail.kde.org/mailman/listinfo/kde-pim
KDE PIM home page at http://pim.kde.org/