From kde-commits  Tue Sep 20 21:13:25 2005
From: Will Stephenson <lists () stevello ! free-online ! co ! uk>
Date: Tue, 20 Sep 2005 21:13:25 +0000
To: kde-commits
Subject: branches/KDE/3.5/kdepim/kontact/plugins/newsticker
Message-Id: <1127250805.609951.23639.nullmailer () svn ! kde ! org>
X-MARC-Message: https://marc.info/?l=kde-commits&m=112725082517375

SVN commit 462367 by wstephens:

Add api docs for newly added function and some existing functions.

Does this mean I'm still a cauliflower?



 M  +15 -1     summarywidget.h  


--- branches/KDE/3.5/kdepim/kontact/plugins/newsticker/summarywidget.h #462366:462367
@@ -68,10 +68,24 @@
     void updateSummary( bool force = false );
 
   k_dcop:
+    /**
+     * Inform the newsticker summary widget that an RSSDocument has been updated.
+     */
     void documentUpdated( DCOPRef );
+    /**
+     * Inform the newsticker summary widget that a feed has been added.
+     */
     void documentAdded( QString );
+    /**
+     * Inform the newsticker summary widget that a feed has been removed.
+     */
     void documentRemoved( QString );
-    void documentUpdateError( DCOPRef, int );
+    /**
+     * Inform the newsticker summary widget that an error occurred while updating a feed.
+     * @param ref DCOPRef to the failing RSSDocument.
+     * @param errorCode indicates the cause of the failure: 1 = RSS Parse Error, 2 = Could not access file, 3 = Unknown error.
+     */
+    void documentUpdateError( DCOPRef ref, int errorCode );
 
   public slots:
     void configChanged();