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

List:       kde-commits
Subject:    Re: KDE/kdepimlibs/akonadi
From:       Mantia Andras <amantia () kde ! org>
Date:       2009-05-07 8:48:43
Message-ID: 200905071148.43947.amantia () kde ! org
[Download RAW message or body]

On Thursday 07 May 2009, Tobias Koenig wrote:
> Hej Andras,
>
> > Store the collection ID in the item. It can be get with the
> > ItemFetchJob.
> >
> >  M  +10 -0     item.cpp
> >  M  +12 -0     item.h
> >  M  +2 -0      item_p.h
> >  M  +7 -4      itemfetchjob.cpp
> >  M  +1 -1      session_p.h
> >
> >
> > --- trunk/KDE/kdepimlibs/akonadi/item.h #964414:964415
> > @@ -222,6 +222,18 @@
> >      int revision() const;
> >
> >      /**
> > +     * Set the collection ID to where the item belongs to.
> > +     * @param collectionId
> > +     */
> > +    void setCollectionId( Entity::Id collectionId);
>
> Could you add the @since 4.3 tags, please?

Yes, already on my todo for today.

>
> > +
> > +    /**
> > +     * Get the collection ID of the item.
> > +     * @return -1 if the collection ID is not know, use
> > ItemFetchJob to query for the collection id.
> > +     */
> > +    Entity::Id collectionId() const;
>
> Same here and rephrase to 'Returns the collection id...'

Is there a guideline about it? This is what this expands to:
<strong>Returns</strong>:
-1 if the collection ID is not know, use ItemFetchJob to query for the 
collection id. 


I like it, as it creates a separate section for return value. Or maybe I 
misunderstood and the problem is not with the @return, but the phrase 
after. :)

Andras


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