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

List:       kmail-devel
Subject:    Re: [PATCH] fix calls to deprecated methods of KABC::Addressbook
From:       Andreas Gungl <a.gungl () gmx ! de>
Date:       2003-12-31 20:57:24
Message-ID: 200312312203.15619 () gungl-dd ! de
[Download RAW message or body]

-----BEGIN PGP SIGNED MESSAGE-----
Hash: SHA1

On Mittwoch, 31. Dezember 2003 18:43, Cornelius Schumacher wrote:
> On Wednesday 31 December 2003 16:37, Andreas Gungl wrote:
> > On Mittwoch, 31. Dezember 2003 15:34, Cornelius Schumacher wrote:
> > > If the save fails the caller has to release the ticket.
> >
> >     /**
> >       Saves all addressees of one resource synchronously. If the save
> > is successfull the ticket is deleted.
> >
> >       @param ticket The ticket returned by requestSaveTicket().
> >       @return Whether the saving was successfully.
> >      */
> >     bool save( Ticket *ticket );
> >
> > I'll changed that, but please update the documentation in
> > addressbook.h to reflect that demand.
>
> What is missing? "If the save is successfull the ticket is deleted" is
> equivalent to "If the save fails the caller has to release the ticket",
> isn't it?

Well, applying boolean logic to that, you're right. What about an addition 
like:
In case of an error you can try again with the still valid ticket. Otherwise 
make sure to release the ticket using releaseSaveTicket().

If you've written the code than many things are logical for you. But a 
documentation should IMHO be more verbose with regard to possible scenarios 
for a "user" who tries to understand internals the first time.

This is my personal opinion. Maybe others want to comment to this issue too. 
If I'm the only one who had problems then you better keep the current 
phrase.

Andreas
- -- 
    ~
  ' v '
 //   \\
/(     )\  Powered by Penguin.
  ^ ' ^

-----BEGIN PGP SIGNATURE-----
Version: GnuPG v1.2.2-rc1-SuSE (GNU/Linux)

iD8DBQE/8zmPVhjiFd4beU8RAufyAKDZEGYEdmDPUjFB8Oj3BcMm4Pcu5wCgyr+N
uCPxOLTXeVcta0sBO6Xckgc=
=Pd+8
-----END PGP SIGNATURE-----

_______________________________________________
KMail developers mailing list
KMail-devel@kde.org
https://mail.kde.org/mailman/listinfo/kmail-devel

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