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

List:       kde-commits
Subject:    KDE/kdepim/akonadi/libakonadi
From:       Volker Krause <volker.krause () rwth-aachen ! de>
Date:       2006-10-03 19:28:00
Message-ID: 1159903680.633982.7503.nullmailer () svn ! kde ! org
[Download RAW message or body]

SVN commit 592074 by vkrause:

API docs fixes.


 M  +4 -0      agentmanager.h  
 M  +1 -0      collectionrenamejob.h  
 M  +1 -1      itemappendjob.h  
 M  +1 -1      itemdeletejob.h  
 M  +1 -1      itemfetchjob.h  
 M  +2 -2      messagecollectionmodel.h  


--- trunk/KDE/kdepim/akonadi/libakonadi/agentmanager.h #592073:592074
@@ -26,6 +26,9 @@
 
 namespace Akonadi {
 
+/**
+  This class provides an interface to manage agents.
+*/
 class AgentManager : public QObject
 {
   Q_OBJECT
@@ -162,6 +165,7 @@
     /**
      * Sets the configuration of agent instance with the given @p identifier.
      *
+     * @param identifier The identifier of the agent to configure.
      * @param data The configuration data in xml format.
      * @returns true if the configuration was accepted and applyed, false otherwise.
      */
--- trunk/KDE/kdepim/akonadi/libakonadi/collectionrenamejob.h #592073:592074
@@ -37,6 +37,7 @@
       Create a new rename job.
       @param from Collection source path.
       @param to Collection destination path.
+      @param parent The parent object.
     */
     CollectionRenameJob( const QString &from, const QString &to, QObject *parent = 0 );
 
--- trunk/KDE/kdepim/akonadi/libakonadi/itemappendjob.h #592073:592074
@@ -45,7 +45,7 @@
 
     /**
       Sets the remote id of the new item (should only be used by resources).
-      @param The remote id.
+      @param remoteId The remote id.
     */
     void setRemoteId( const QString &remoteId );
 
--- trunk/KDE/kdepim/akonadi/libakonadi/itemdeletejob.h #592073:592074
@@ -27,7 +27,7 @@
 class ItemDeleteJobPrivate;
 
 /**
-  Convenience job which permanently deletes an item, ie. sets the \Deleted flag
+  Convenience job which permanently deletes an item, ie. sets the \\Deleted flag
   and then executes the EXPUNGE command.
 */
 class ItemDeleteJob : public Job
--- trunk/KDE/kdepim/akonadi/libakonadi/itemfetchjob.h #592073:592074
@@ -63,7 +63,7 @@
 
     /**
       Fetch additional field.
-      @param fields Additional fields to fetch.
+      @param field Additional field to fetch.
     */
     void addFetchField( const QByteArray &field );
 
--- trunk/KDE/kdepim/akonadi/libakonadi/messagecollectionmodel.h #592073:592074
@@ -23,12 +23,12 @@
 #include <libakonadi/collectionmodel.h>
 #include <kdepim_export.h>
 
+namespace Akonadi {
+
 /**
   Extended modell for message collections.
   Supports columns for message unread/total counts.
 */
-namespace Akonadi {
-
 class AKONADI_EXPORT MessageCollectionModel : public CollectionModel
 {
   Q_OBJECT
[prev in list] [next in list] [prev in thread] [next in thread]