ekiga r5994 - in trunk: . lib/engine/addressbook/skel lib/engine/framework lib/engine/presence/skel lib/engine/protocol/skel

[jpuydt svn gnome org]

Author: jpuydt
Date: Tue Feb 26 14:08:50 2008
New Revision: 5994
URL: http://svn.gnome.org/viewvc/ekiga?rev=5994&view=rev

Log:
Commented the better visitors api


Modified:
   trunk/ChangeLog
   trunk/lib/engine/addressbook/skel/book-impl.h
   trunk/lib/engine/addressbook/skel/book.h
   trunk/lib/engine/addressbook/skel/contact-core.h
   trunk/lib/engine/addressbook/skel/source-impl.h
   trunk/lib/engine/addressbook/skel/source.h
   trunk/lib/engine/framework/lister.h
   trunk/lib/engine/presence/skel/heap.h
   trunk/lib/engine/presence/skel/presence-core.h
   trunk/lib/engine/protocol/skel/call-core.h

Modified: trunk/lib/engine/addressbook/skel/book-impl.h
==============================================================================
--- trunk/lib/engine/addressbook/skel/book-impl.h	(original)
+++ trunk/lib/engine/addressbook/skel/book-impl.h	Tue Feb 26 14:08:50 2008
@@ -92,7 +92,8 @@
 
 
     /** Visit all contacts of the book and trigger the given callback.
-     * @param The callback.
+     * @param The callback (the return value means "go on" and allows
+     *  stopping the visit)
      */
     void visit_contacts (sigc::slot<bool, Contact &> visitor);
 

Modified: trunk/lib/engine/addressbook/skel/book.h
==============================================================================
--- trunk/lib/engine/addressbook/skel/book.h	(original)
+++ trunk/lib/engine/addressbook/skel/book.h	Tue Feb 26 14:08:50 2008
@@ -60,7 +60,8 @@
     /** Visit all contacts of the book and trigger the given callback.
      * This function is purely virtual and should be implemented by
      * the descendant of the Ekiga::Book.
-     * @param The callback.
+     * @param The callback (the return value means "go on" and allows
+     *  stopping the visit)
      */
     virtual void visit_contacts (sigc::slot<bool, Contact &>) = 0;
 

Modified: trunk/lib/engine/addressbook/skel/contact-core.h
==============================================================================
--- trunk/lib/engine/addressbook/skel/contact-core.h	(original)
+++ trunk/lib/engine/addressbook/skel/contact-core.h	Tue Feb 26 14:08:50 2008
@@ -105,7 +105,8 @@
 
     /** Triggers a callback for all Ekiga::Source sources of the
      * ContactCore service.
-     * @param The callback.
+     * @param The callback (the return value means "go on" and allows
+     *  stopping the visit)
      */
     void visit_sources (sigc::slot<bool, Source &> visitor);
 

Modified: trunk/lib/engine/addressbook/skel/source-impl.h
==============================================================================
--- trunk/lib/engine/addressbook/skel/source-impl.h	(original)
+++ trunk/lib/engine/addressbook/skel/source-impl.h	Tue Feb 26 14:08:50 2008
@@ -100,7 +100,8 @@
 
 
     /** Visit all books of the source and trigger the given callback.
-     * @param The callback.
+     * @param The callback (the return value means "go on" and allows
+     *  stopping the visit)
      */
     void visit_books (sigc::slot<bool, Book &> visitor);
 

Modified: trunk/lib/engine/addressbook/skel/source.h
==============================================================================
--- trunk/lib/engine/addressbook/skel/source.h	(original)
+++ trunk/lib/engine/addressbook/skel/source.h	Tue Feb 26 14:08:50 2008
@@ -54,7 +54,8 @@
     /** Visit all books of the source and trigger the given callback.
      * This function is purely virtual and should be implemented by
      * the descendant of the Ekiga::Source.
-     * @param The callback.
+     * @param The callback (the return value means "go on" and allows
+     *  stopping the visit)
      */
     virtual void visit_books (sigc::slot<bool, Book &>) = 0;
 

Modified: trunk/lib/engine/framework/lister.h
==============================================================================
--- trunk/lib/engine/framework/lister.h	(original)
+++ trunk/lib/engine/framework/lister.h	Tue Feb 26 14:08:50 2008
@@ -86,6 +86,8 @@
 
 
     /** Allows listing all objects
+     * @param The callback (the return value means "go on" and allows
+     *  stopping the visit)
      */
     void visit_objects (sigc::slot<bool, ObjectType &> visitor);
 

Modified: trunk/lib/engine/presence/skel/heap.h
==============================================================================
--- trunk/lib/engine/presence/skel/heap.h	(original)
+++ trunk/lib/engine/presence/skel/heap.h	Tue Feb 26 14:08:50 2008
@@ -63,7 +63,8 @@
     virtual const std::string get_name () const = 0;
 
     /** Get the list of Presentities by visiting them with a callback.
-     * @param The callback user to know about presentities.
+     * @param The callback user to know about presentities (the return value
+     * means "go on" and allows stopping the visit)
      */
     virtual void visit_presentities (sigc::slot<bool, Presentity &>) = 0;
 

Modified: trunk/lib/engine/presence/skel/presence-core.h
==============================================================================
--- trunk/lib/engine/presence/skel/presence-core.h	(original)
+++ trunk/lib/engine/presence/skel/presence-core.h	Tue Feb 26 14:08:50 2008
@@ -177,7 +177,8 @@
 
     /** Triggers a callback for all Ekiga::Cluster clusters of the
      * PresenceCore service.
-     * @param The callback.
+     * @param The callback (the return value means "go on" and allows
+     *  stopping the visit)
      */
     void visit_clusters (sigc::slot<bool, Cluster &> visitor);
 

Modified: trunk/lib/engine/protocol/skel/call-core.h
==============================================================================
--- trunk/lib/engine/protocol/skel/call-core.h	(original)
+++ trunk/lib/engine/protocol/skel/call-core.h	Tue Feb 26 14:08:50 2008
@@ -94,6 +94,8 @@
 
       /** Triggers a callback for all Ekiga::CallManager sources of the
        * CallCore service.
+       * @param The callback (the return value means "go on" and allows
+       * stopping the visit)
        */
       void visit_managers (sigc::slot<bool, CallManager &> visitor);