[Kde-pim] API review todos

[Stephen Kelly]

Much done, the remaining ones as far as I know: tokoe may have already done 
more.

Stephen Kelly wrote:

>  
>  public:
>  diff --git a/akonadi/entitydisplayattribute.h
>  b/akonadi/entitydisplayattribute.h index c4865d3..9f99ee7 100644
>  --- a/akonadi/entitydisplayattribute.h
>  +++ b/akonadi/entitydisplayattribute.h
>  @@ -74,6 +74,7 @@ class AKONADI_EXPORT EntityDisplayAttribute : public
>  Attribute */
>  QString iconName() const;
>  
>  +    // TODO: Remove these in favour of the EntityHiddenAttribute and
>  port the model and kolab resource. /**
>  * Returns whether this entity should be hidden. This is for purely
>  view-based hiding, * comparable to hidden files, the entity will always
>  
>  namespace Akonadi {
>  
>  +// TODO: Tokoe: add more API dox. (Hidden Attribute)
>  +
>  /**
>  * @short Attribute signalling that an entity should be hidden in the UI
>  *
>  diff --git a/akonadi/entitytreeview.h b/akonadi/entitytreeview.h
>  index c37e6d2..e93fb06 100644
>  --- a/akonadi/entitytreeview.h
>  +++ b/akonadi/entitytreeview.h
>  @@ -34,6 +34,8 @@ namespace Akonadi
>  class Collection;
>  class Item;
>  
>  +// TODO: Update dox.
>  +
>  /**
>  * @short A view to show a collection tree provided by a CollectionModel.
>  *
>  diff --git a/akonadi/favoritecollectionsmodel.cpp
>  b/akonadi/favoritecollectionsmodel.cpp index f6886eb..eb9c495 100644
>  --- a/akonadi/favoritecollectionsmodel.cpp
>  +++ b/akonadi/favoritecollectionsmodel.cpp
>  @@ -71,6 +71,7 @@ class FavoriteCollectionsModel::Private
>  QItemSelectionModel::Select );
>  }
>  }
>  +// TODO: Don't use KGlobalConfig. Add API for using a specific config to
>  not break in kontact.
>  
>  void loadConfig()
>  {
>  @@ -111,7 +112,7 @@ class FavoriteCollectionsModel::Private
>  QHash<qint64, QString> labelMap;
>  };
>  
>  -FavoriteCollectionsModel::FavoriteCollectionsModel( EntityTreeModel
>  *source, QObject *parent )
>  +FavoriteCollectionsModel::FavoriteCollectionsModel( QAbstractItemModel
>  *source, QObject *parent ) : Akonadi::SelectionProxyModel( new
>  QItemSelectionModel( source, parent ), parent ), d( new Private( this ) )
>  { diff --git a/akonadi/favoritecollectionsmodel.h
>  b/akonadi/favoritecollectionsmodel.h index 8042fba..f1dcba9 100644
>  --- a/akonadi/favoritecollectionsmodel.h
>  +++ b/akonadi/favoritecollectionsmodel.h
>  @@ -30,6 +30,7 @@ namespace Akonadi {
>  
>  class EntityTreeModel;
>  
>  +// TODO: tokoe: dox
>  /**
>  * @short A model that lists a set of favorite collections.
>  *
>  @@ -46,7 +47,8 @@ class AKONADI_EXPORT FavoriteCollectionsModel : public
>  Akonadi::SelectionProxyMo *
>  * @param parent The parent object.
>  */
>  -    explicit FavoriteCollectionsModel( EntityTreeModel *source, QObject
>  *parent = 0 ); +    explicit FavoriteCollectionsModel( QAbstractItemModel
>  *source, QObject *parent = 0 ); +// TODO: Add a KConfigGroup to the
>  constructor
>  
>  /**
>  * Destroys the favorite collections model.
>  diff --git a/akonadi/favoritecollectionsview.cpp
>  b/akonadi/favoritecollectionsview.cpp index 8182875..a87fec0 100644
>  --- a/akonadi/favoritecollectionsview.cpp
>  +++ b/akonadi/favoritecollectionsview.cpp
>  @@ -169,6 +169,8 @@ void FavoriteCollectionsView::dropEvent( QDropEvent *
>  event ) }
>  }
>  
>  +// TODO: make accessor for kxmlguiclient
>  +
>  void FavoriteCollectionsView::contextMenuEvent( QContextMenuEvent * event
>  ) {
>  if ( !d->mXmlGuiClient )
>  diff --git a/akonadi/filteractionjob.h b/akonadi/filteractionjob.h
>  index e607510..a4a5297 100644
>  --- a/akonadi/filteractionjob.h
>  +++ b/akonadi/filteractionjob.h
>  @@ -23,6 +23,8 @@
>  #include "item.h"
>  #include "transactionsequence.h"
>  
>  +//TODO: Make private. Only used by MailTransport::DispatcherInterface
>  +
>  namespace Akonadi {
>  
>  class Collection;
>  diff --git a/akonadi/item.h b/akonadi/item.h
>  index dc5be92..7191c25 100644
>  --- a/akonadi/item.h
>  +++ b/akonadi/item.h
>  @@ -322,6 +322,7 @@ class AKONADI_EXPORT Item : public Entity
>  *
>  * @since 4.4
>  */
>  +    // TODO: Better dox here.
>  QSet<QByteArray> availablePayloadParts() const;
>  
>  /**
>  diff --git a/akonadi/itemmodel.h b/akonadi/itemmodel.h
>  index faf3e91..381dc38 100644
>  --- a/akonadi/itemmodel.h
>  +++ b/akonadi/itemmodel.h
>  @@ -54,6 +54,7 @@ class Session;
>  */
>  class AKONADI_EXPORT ItemModel : public QAbstractTableModel
>  {
>  +       // TODO: Deprecate this and CollectionModel and implement the
>  necessary stuff in Monitor::setCollectionMonitored Q_OBJECT
>  
>  public:
>  diff --git a/akonadi/partfetcher.h b/akonadi/partfetcher.h
>  index 5a3e75d..6792373 100644
>  --- a/akonadi/partfetcher.h
>  +++ b/akonadi/partfetcher.h
>  @@ -32,6 +32,10 @@ namespace Akonadi
>  class Item;
>  class PartFetcherPrivate;
>  
>  +// TODO: Make the Akonadi::SelectionProxyModel use this internally.
>  +
>  +// TODO: Tokoe
>  +
>  /**
>  * @short Convenience class for getting payload parts from an Akonadi
>  Model. *
>  diff --git a/akonadi/preprocessorbase.h b/akonadi/preprocessorbase.h
>  index b4942c9..9936e52 100644
>  --- a/akonadi/preprocessorbase.h
>  +++ b/akonadi/preprocessorbase.h
>  @@ -114,6 +114,8 @@ class AKONADI_EXPORT PreprocessorBase : public
>  AgentBase * appropriately (as the server MAY abort your async job
>  * if it decides that it's taking too long).
>  */
>  +    // TODO: The Id's stuff should be hidden and should fetch the Item
>  and call fetchItem(item) +    // Also need a setter for the
>  itemfetchscope. virtual ProcessingResult processItem( Item::Id itemId,
>  Collection::Id collectionId, const QString &mimeType ) = 0;
>  
>  /**
>  --- a/akonadi/selectionproxymodel.h
>  +++ b/akonadi/selectionproxymodel.h
>  @@ -26,6 +26,8 @@
>  
>  #include "akonadi_export.h"
>  
>  +// TODO: tokoe apidox
>  +
>  namespace Akonadi
>  {
>  



_______________________________________________
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/