GNOME.org
 

ekiga r5920 - in trunk: . lib/engine lib/engine/addressbook/call-history lib/engine/addressbook/evolution lib/engine/addressbook/kab lib/engine/addressbook/ldap lib/engine/addressbook/skel lib/engine/display/skel lib/engine/framework lib/engine/presence/avahi lib/engine/presence/local-roster lib/engine/presence/skel lib/engine/protocol/skel

Author: sfre
Date: Wed Jan 16 20:09:33 2008
New Revision: 5920
URL: http://svn.gnome.org/viewvc/ekiga?rev=5920&view=rev

Log:
Engine documentation enhancement


Modified:
   trunk/ChangeLog
   trunk/Doxyfile.in
   trunk/lib/engine/addressbook/call-history/history-book.h
   trunk/lib/engine/addressbook/call-history/history-contact.h
   trunk/lib/engine/addressbook/call-history/history-main.h
   trunk/lib/engine/addressbook/call-history/history-source.h
   trunk/lib/engine/addressbook/evolution/evolution-book.h
   trunk/lib/engine/addressbook/evolution/evolution-contact.h
   trunk/lib/engine/addressbook/evolution/evolution-main.h
   trunk/lib/engine/addressbook/evolution/evolution-source.h
   trunk/lib/engine/addressbook/kab/kab-book.h
   trunk/lib/engine/addressbook/kab/kab-contact.h
   trunk/lib/engine/addressbook/kab/kab-main.h
   trunk/lib/engine/addressbook/kab/kab-source.h
   trunk/lib/engine/addressbook/ldap/ldap-book.h
   trunk/lib/engine/addressbook/ldap/ldap-contact.h
   trunk/lib/engine/addressbook/ldap/ldap-main.h
   trunk/lib/engine/addressbook/ldap/ldap-source.h
   trunk/lib/engine/addressbook/skel/book-impl.h
   trunk/lib/engine/addressbook/skel/contact-core.h
   trunk/lib/engine/addressbook/skel/contact.h
   trunk/lib/engine/addressbook/skel/source-impl.h
   trunk/lib/engine/display/skel/display-core.h
   trunk/lib/engine/display/skel/display-info.h
   trunk/lib/engine/display/skel/display-manager.h
   trunk/lib/engine/engine.h
   trunk/lib/engine/framework/form-builder.h
   trunk/lib/engine/framework/form-dumper.h
   trunk/lib/engine/framework/form-request-simple.h
   trunk/lib/engine/framework/form-request.h
   trunk/lib/engine/framework/form-visitor.h
   trunk/lib/engine/framework/form.h
   trunk/lib/engine/framework/lister.h
   trunk/lib/engine/framework/menu-builder.h
   trunk/lib/engine/framework/menu-xml.h
   trunk/lib/engine/framework/runtime-glib.h
   trunk/lib/engine/framework/runtime.h
   trunk/lib/engine/framework/services.h
   trunk/lib/engine/framework/trigger.h
   trunk/lib/engine/presence/avahi/avahi-cluster.h
   trunk/lib/engine/presence/avahi/avahi-heap.h
   trunk/lib/engine/presence/avahi/avahi-presentity.h
   trunk/lib/engine/presence/local-roster/local-cluster.h
   trunk/lib/engine/presence/local-roster/local-heap.h
   trunk/lib/engine/presence/local-roster/local-presentity.h
   trunk/lib/engine/presence/skel/cluster-impl.h
   trunk/lib/engine/protocol/skel/call-core.h
   trunk/lib/engine/protocol/skel/call-manager.h
   trunk/lib/engine/protocol/skel/call.h
   trunk/lib/engine/protocol/skel/codec-description.h

Modified: trunk/Doxyfile.in
==============================================================================
--- trunk/Doxyfile.in	(original)
+++ trunk/Doxyfile.in	Wed Jan 16 20:09:33 2008
@@ -249,7 +249,7 @@
 # Private class members and static file members will be hidden unless
 # the EXTRACT_PRIVATE and EXTRACT_STATIC tags are set to YES
 
-EXTRACT_ALL            = YES
+EXTRACT_ALL            = NO
 
 # If the EXTRACT_PRIVATE tag is set to YES all private members of a class
 # will be included in the documentation.
@@ -503,7 +503,7 @@
 # *.c *.cc *.cxx *.cpp *.c++ *.java *.ii *.ixx *.ipp *.i++ *.inl *.h *.hh *.hxx
 # *.hpp *.h++ *.idl *.odl *.cs *.php *.php3 *.inc *.m *.mm *.py
 
-FILE_PATTERNS          =
+FILE_PATTERNS          = *.h
 
 # The RECURSIVE tag can be used to turn specify whether or not subdirectories
 # should be searched for input files as well. Possible values are YES and NO.

Modified: trunk/lib/engine/addressbook/call-history/history-book.h
==============================================================================
--- trunk/lib/engine/addressbook/call-history/history-book.h	(original)
+++ trunk/lib/engine/addressbook/call-history/history-book.h	Wed Jan 16 20:09:33 2008
@@ -43,6 +43,13 @@
 
 namespace History
 {
+
+/**
+ * @addtogroup contacts
+ * @internal
+ * @{
+ */
+
   class Book
     : public Ekiga::BookImpl<Contact, Ekiga::delete_object_management <Contact> >
   {
@@ -85,6 +92,11 @@
     Ekiga::ContactCore *contact_core;
     xmlDocPtr doc;
   };
+
+/**
+ * @}
+ */
+
 };
 
 #endif

Modified: trunk/lib/engine/addressbook/call-history/history-contact.h
==============================================================================
--- trunk/lib/engine/addressbook/call-history/history-contact.h	(original)
+++ trunk/lib/engine/addressbook/call-history/history-contact.h	Wed Jan 16 20:09:33 2008
@@ -41,7 +41,14 @@
 #include "services.h"
 #include "contact-core.h"
 
-namespace History {
+namespace History
+{
+
+/**
+ * @addtogroup contacts
+ * @internal
+ * @{
+ */
 
   typedef enum {
 
@@ -92,6 +99,11 @@
     std::string status;
     std::set<std::string> groups;
   };
+
+/**
+ * @}
+ */
+
 };
 
 #endif

Modified: trunk/lib/engine/addressbook/call-history/history-main.h
==============================================================================
--- trunk/lib/engine/addressbook/call-history/history-main.h	(original)
+++ trunk/lib/engine/addressbook/call-history/history-main.h	Wed Jan 16 20:09:33 2008
@@ -40,8 +40,17 @@
 
 #include "services.h"
 
+/**
+ * @addtogroup contacts
+ * @{
+ */
+
 bool history_init (Ekiga::ServiceCore &core,
 		   int *argc,
 		   char **argv[]);
 
+/**
+ * @}
+ */
+
 #endif

Modified: trunk/lib/engine/addressbook/call-history/history-source.h
==============================================================================
--- trunk/lib/engine/addressbook/call-history/history-source.h	(original)
+++ trunk/lib/engine/addressbook/call-history/history-source.h	Wed Jan 16 20:09:33 2008
@@ -41,6 +41,13 @@
 
 namespace History
 {
+
+/**
+ * @addtogroup contacts
+ * @internal
+ * @{
+ */
+
   class Source :
     public Ekiga::SourceImpl<Book, Ekiga::delete_book_management<Book> >,
     public Ekiga::Service
@@ -70,6 +77,12 @@
     Book *book;
 
   };
+
+/**
+ * @addtogroup contacts
+ * @}
+ */
+
 }
 
 #endif

Modified: trunk/lib/engine/addressbook/evolution/evolution-book.h
==============================================================================
--- trunk/lib/engine/addressbook/evolution/evolution-book.h	(original)
+++ trunk/lib/engine/addressbook/evolution/evolution-book.h	Wed Jan 16 20:09:33 2008
@@ -50,6 +50,12 @@
 namespace Evolution
 {
 
+/**
+ * @addtogroup contacts
+ * @internal
+ * @{
+ */
+
   class Book:
     public Ekiga::BookImpl<Contact, Ekiga::delete_object_management<Contact> >
   {
@@ -96,6 +102,10 @@
     std::string search_filter;
   };
 
+/**
+ * @}
+ */
+
 };
 
 #endif

Modified: trunk/lib/engine/addressbook/evolution/evolution-contact.h
==============================================================================
--- trunk/lib/engine/addressbook/evolution/evolution-contact.h	(original)
+++ trunk/lib/engine/addressbook/evolution/evolution-contact.h	Wed Jan 16 20:09:33 2008
@@ -47,6 +47,12 @@
 namespace Evolution
 {
 
+/**
+ * @addtogroup contacts
+ * @internal
+ * @{
+ */
+
   class Contact: public Ekiga::Contact
   {
   public:
@@ -103,6 +109,10 @@
     void on_edit_form_submitted (Ekiga::Form &result);
   };
 
+/**
+ * @}
+ */
+
 };
 
 #endif

Modified: trunk/lib/engine/addressbook/evolution/evolution-main.h
==============================================================================
--- trunk/lib/engine/addressbook/evolution/evolution-main.h	(original)
+++ trunk/lib/engine/addressbook/evolution/evolution-main.h	Wed Jan 16 20:09:33 2008
@@ -40,8 +40,17 @@
 
 #include "services.h"
 
+/**
+ * @addtogroup contacts
+ * @{
+ */
+
 bool evolution_init (Ekiga::ServiceCore &services,
 		     int *argc,
 		     char **argv[]);
 
+/**
+ * @}
+ */
+
 #endif

Modified: trunk/lib/engine/addressbook/evolution/evolution-source.h
==============================================================================
--- trunk/lib/engine/addressbook/evolution/evolution-source.h	(original)
+++ trunk/lib/engine/addressbook/evolution/evolution-source.h	Wed Jan 16 20:09:33 2008
@@ -48,6 +48,12 @@
 namespace Evolution
 {
 
+/**
+ * @addtogroup contacts
+ * @internal
+ * @{
+ */
+
   class Source: public Ekiga::SourceImpl<Book, Ekiga::delete_book_management<Book> >
   {
   public:
@@ -69,6 +75,11 @@
     Ekiga::ServiceCore &services;
     ESourceList *source_list;
   };
+
+/**
+ * @}
+ */
+
 };
 
 #endif

Modified: trunk/lib/engine/addressbook/kab/kab-book.h
==============================================================================
--- trunk/lib/engine/addressbook/kab/kab-book.h	(original)
+++ trunk/lib/engine/addressbook/kab/kab-book.h	Wed Jan 16 20:09:33 2008
@@ -45,6 +45,12 @@
 namespace KAB
 {
 
+/**
+ * @addtogroup contacts
+ * @internal
+ * @{
+ */
+
   class Book:
     public Ekiga::BookImpl<Contact, Ekiga::delete_contact_management<Contact> >
   {
@@ -63,6 +69,10 @@
     Ekiga::ContactCore &core;
   };
 
+/**
+ * @}
+ */
+
 };
 
 #endif

Modified: trunk/lib/engine/addressbook/kab/kab-contact.h
==============================================================================
--- trunk/lib/engine/addressbook/kab/kab-contact.h	(original)
+++ trunk/lib/engine/addressbook/kab/kab-contact.h	Wed Jan 16 20:09:33 2008
@@ -46,6 +46,12 @@
 namespace KAB
 {
 
+/**
+ * @addtogroup contacts
+ * @internal
+ * @{
+ */
+
   class Contact: public Ekiga::Contact
   {
   public:
@@ -74,6 +80,10 @@
 
   };
 
+/**
+ * @}
+ */
+
 };
 
 #endif

Modified: trunk/lib/engine/addressbook/kab/kab-main.h
==============================================================================
--- trunk/lib/engine/addressbook/kab/kab-main.h	(original)
+++ trunk/lib/engine/addressbook/kab/kab-main.h	Wed Jan 16 20:09:33 2008
@@ -40,8 +40,17 @@
 
 #include "services.h"
 
+/**
+ * @addtogroup contacts
+ * @{
+ */
+
 bool kab_init (Ekiga::ServiceCore &core,
 	       int *argc,
 	       char **argv[]);
 
+/**
+ * @}
+ */
+
 #endif

Modified: trunk/lib/engine/addressbook/kab/kab-source.h
==============================================================================
--- trunk/lib/engine/addressbook/kab/kab-source.h	(original)
+++ trunk/lib/engine/addressbook/kab/kab-source.h	Wed Jan 16 20:09:33 2008
@@ -46,6 +46,12 @@
 namespace KAB
 {
 
+/**
+ * @addtogroup contacts
+ * @internal
+ * @{
+ */
+
   class Source: public Ekiga::SourceImpl<Book, Ekiga::delete_book_management<Book> >
   {
   public:
@@ -60,6 +66,11 @@
 
     Ekiga::ContactCore &core;
   };
+
+/**
+ * @}
+ */
+
 };
 
 #endif

Modified: trunk/lib/engine/addressbook/ldap/ldap-book.h
==============================================================================
--- trunk/lib/engine/addressbook/ldap/ldap-book.h	(original)
+++ trunk/lib/engine/addressbook/ldap/ldap-book.h	Wed Jan 16 20:09:33 2008
@@ -49,6 +49,13 @@
 
 namespace OPENLDAP
 {
+
+/**
+ * @addtogroup contacts
+ * @internal
+ * @{
+ */
+
   class Book:
     public Ekiga::BookImpl<Contact, Ekiga::delete_object_management<Contact> >
   {
@@ -118,6 +125,11 @@
 
     Ekiga::Runtime & runtime;
   };
+
+/**
+ * @}
+ */
+
 };
 
 #endif

Modified: trunk/lib/engine/addressbook/ldap/ldap-contact.h
==============================================================================
--- trunk/lib/engine/addressbook/ldap/ldap-contact.h	(original)
+++ trunk/lib/engine/addressbook/ldap/ldap-contact.h	Wed Jan 16 20:09:33 2008
@@ -42,6 +42,13 @@
 
 namespace OPENLDAP
 {
+
+/**
+ * @addtogroup contacts
+ * @internal
+ * @{
+ */
+
   class Contact: public Ekiga::Contact
   {
   public:
@@ -70,6 +77,11 @@
 
     std::map<std::string, std::string> uris;
   };
+
+/**
+ * @}
+ */
+
 };
 
 #endif

Modified: trunk/lib/engine/addressbook/ldap/ldap-main.h
==============================================================================
--- trunk/lib/engine/addressbook/ldap/ldap-main.h	(original)
+++ trunk/lib/engine/addressbook/ldap/ldap-main.h	Wed Jan 16 20:09:33 2008
@@ -40,8 +40,17 @@
 
 #include "services.h"
 
+/**
+ * @addtogroup contacts
+ * @{
+ */
+
 bool ldap_init (Ekiga::ServiceCore &core,
 		int *argc,
 		char **argv[]);
 
+/**
+ * @}
+ */
+
 #endif

Modified: trunk/lib/engine/addressbook/ldap/ldap-source.h
==============================================================================
--- trunk/lib/engine/addressbook/ldap/ldap-source.h	(original)
+++ trunk/lib/engine/addressbook/ldap/ldap-source.h	Wed Jan 16 20:09:33 2008
@@ -48,6 +48,12 @@
 namespace OPENLDAP
 {
 
+/**
+ * @addtogroup contacts
+ * @internal
+ * @{
+ */
+
   class Source:
     public Ekiga::SourceImpl<Book, Ekiga::delete_book_management<Book> >,
     public Ekiga::Service
@@ -89,6 +95,11 @@
     void new_book ();
     void on_new_book_form_submitted (Ekiga::Form &result);
   };
+
+/**
+ * @}
+ */
+
 };
 
 #endif

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	Wed Jan 16 20:09:33 2008
@@ -41,34 +41,41 @@
 #include "book.h"
 
 
-/** Ekiga::Book
- *
- * This class is there to make it easy to implement a new type of contact
- * addressbook : it will take care of implementing the external api, you
- * just have to decide when to add and remove contacts.
- *
- * It also provides basic memory management for contacts, with the second
- * (optional) template argument :
- * - either no management (the default) ;
- * - or the contact is considered bound to one Ekiga::Book, which will trigger its
- * destruction (using delete) when removed from it.
- *
- * You can remove a contact from an Ekiga::Book in two ways :
- * - either by calling the remove_contact method,
- * - or by emission of the contact's removed signal.
- *
- * Notice that this class won't take care of removing the contact from a
- * backend -- only from the Ekiga::Book.
- * If you want the contact *deleted* from the real backend, then you
- * probably should have an organization like :
- * - the contact has a 'deleted' signal ;
- * - the book listens to this signal ;
- * - when the signal is received, then do a remove_contact followed by calling
- * the appropriate api function to delete the contact in your backend.
- */
 
-namespace Ekiga {
+namespace Ekiga
+{
+
+/**
+ * @addtogroup contacts
+ * @{
+ */
 
+  /** Generic implementation for the Ekiga::Book abstract class.
+   *
+   * This class is there to make it easy to implement a new type of contact
+   * addressbook: it will take care of implementing the external api, you
+   * just have to decide when to add and remove contacts.
+   *
+   * It also provides basic memory management for Contacts, with the second
+   * (optional) template argument:
+   *  - either no management (the default);
+   *  - or the contact is considered bound to one Ekiga::Book, which will
+   *    trigger its destruction (using delete) when removed from it.
+   *
+   * You can remove a Contact from an Ekiga::Book in two ways:
+   *  - either by calling the remove_contact method,
+   *  - or by emission of the contact's removed signal.
+   *
+   * Notice that this class won't take care of removing the Contact from a
+   * backend -- only from the Ekiga::Book.
+   * If you want the Contact <b>deleted</b> from the real backend, then you
+   * probably should have an organization like:
+   *  - the contact has a 'deleted' signal ;
+   *  - the book listens to this signal ;
+   *  - when the signal is received, then do a remove_contact followed by
+   *    calling the appropriate api function to delete the contact in your
+   *    backend.
+   */
   template<typename ContactType = Contact,
 	   typename ObjectManagementTrait = no_object_management<ContactType> >
   class BookImpl:
@@ -134,6 +141,11 @@
     std::string status;
 
   };
+
+/**
+ * @}
+ */
+
 };
 
 

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	Wed Jan 16 20:09:33 2008
@@ -42,6 +42,12 @@
 /* declaration of a few helper classes */
 namespace Ekiga
 {
+
+/**
+ * @defgroup contacts Address Book
+ * @{
+ */
+
   class ContactDecorator
   {
   public:
@@ -52,15 +58,13 @@
     virtual bool populate_menu (Contact &/*contact*/,
 				MenuBuilder &/*builder*/) = 0;
   };
-};
-
 
-/* notice that you give sources to this object as pointers, and this
- * object then assumes the ownership of the source : it will call delete
- * on each of them when it is destroyed.
- */
-namespace Ekiga
-{
+  /** Core object for address book support.
+   *
+   * Notice that you give sources to this object as pointers, and this
+   * object then assumes the ownership of the source: it will call delete
+   * on each of them when it is destroyed.
+   */
   class ContactCore: public Service
   {
   public:
@@ -191,5 +195,9 @@
     ChainOfResponsibility<FormRequest*> questions;
   };
 
+/**
+ * @}
+ */
+
 };
 #endif

Modified: trunk/lib/engine/addressbook/skel/contact.h
==============================================================================
--- trunk/lib/engine/addressbook/skel/contact.h	(original)
+++ trunk/lib/engine/addressbook/skel/contact.h	Wed Jan 16 20:09:33 2008
@@ -48,6 +48,11 @@
 namespace Ekiga
 {
 
+/**
+ * @addtogroup contacts
+ * @{
+ */
+
   class Contact
   {
   public:
@@ -112,5 +117,9 @@
     ChainOfResponsibility<FormRequest*> questions;
   };
 
+/**
+ * @}
+ */
+
 };
 #endif

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	Wed Jan 16 20:09:33 2008
@@ -45,33 +45,14 @@
 #include "source.h"
 
 
-/** Ekiga::Source
- *
- * This class is there to make it easy to implement a new type of
- * addressbook source : it will take care of implementing the external api, you
- * just have to decide when to add and remove books.
- *
- * It also provides basic memory management for books, with the second
- * (optional) template argument :
- * - either no management (the default) ;
- * - or the book is considered bound to one Ekiga::Source, which will trigger
- * its destruction (using delete) when removed from it.
- *
- * You ca remove a book from an Ekiga::Source in two ways :
- * - either by calling the remove_book method,
- * - or by emission of the book's removed signal.
- *
- * Notice that this class won't take care of removing the book from a
- * backend -- only from the Ekiga::Source.
- * If you want the book *deleted* from the real backend, then you
- * probably should have an organization like :
- * - the book has a 'deleted' signal ;
- * - the source listens for this signal ;
- * - when the signal is received, then do a remove_book followed by calling
- * the appropriate api function to delete the book in your backend.
- */
 
-namespace Ekiga {
+namespace Ekiga
+{
+
+  /**
+   * @addtogroup contacts
+   * @{
+   */
 
   template<typename BookType>
   struct no_book_management
@@ -90,7 +71,32 @@
     static void release (BookType &book);
   };
 
-  template<typename BookType = Book,
+  /** Generic implementation for the Ekiga::Source abstract class.
+   *
+   * This class is there to make it easy to implement a new type of
+   * addressbook source: it will take care of implementing the external api,
+   * you just have to decide when to add and remove books.
+   * 
+   * It also provides basic memory management for books, with the second
+   * (optional) template argument:
+   *  - either no management (the default) ;
+   *  - or the book is considered bound to one Ekiga::Source, which will
+   *    trigger its destruction (using delete) when removed from it.
+   *
+   * You can remove a Book from an Ekiga::Source in two ways:
+   *  - either by calling the remove_book method,
+   *  - or by emission of the book's removed signal.
+   *
+   * Notice that this class won't take care of removing the book from a
+   * backend -- only from the Ekiga::Source.
+   * If you want the Book <b>deleted</b> from the real backend, then you
+   * probably should have an organization like :
+   *  - the book has a 'deleted' signal;
+   *  - the source listens for this signal;
+   *  - when the signal is received, then do a remove_book followed by calling
+   *    the appropriate api function to delete the Book in your backend.
+   */
+ template<typename BookType = Book,
 	   typename BookManagementTrait = no_book_management <BookType> >
   class SourceImpl: public Source
   {
@@ -215,6 +221,11 @@
      */
     std::map<BookType *, std::vector<sigc::connection> > connections;
   };
+
+/**
+ * @}
+ */
+
 };
 
 

Modified: trunk/lib/engine/display/skel/display-core.h
==============================================================================
--- trunk/lib/engine/display/skel/display-core.h	(original)
+++ trunk/lib/engine/display/skel/display-core.h	Wed Jan 16 20:09:33 2008
@@ -47,9 +47,18 @@
 
 #include <glib.h>
 
-namespace Ekiga {
+namespace Ekiga
+{
+
+/**
+ * @defgroup display Video Display
+ * @{
+ */
+
   class DisplayManager;
 
+  /** Core object for the video display support
+   */
   class DisplayCore
     : public Service
     {
@@ -137,7 +146,10 @@
 
       DisplayStats display_stats;
       GTimeVal last_stats;
-    };  
+    };
+/**
+ * @}
+ */
 };
 
 #endif

Modified: trunk/lib/engine/display/skel/display-info.h
==============================================================================
--- trunk/lib/engine/display/skel/display-info.h	(original)
+++ trunk/lib/engine/display/skel/display-info.h	Wed Jan 16 20:09:33 2008
@@ -43,6 +43,12 @@
 #endif
 
 //namespace Ekiga {
+
+/**
+ * @addtogroup display
+ * @{
+ */
+
   /* Video modes */
   typedef enum {
   
@@ -155,7 +161,11 @@
     DisplayMode display;
     unsigned int zoom;
   };
-  
+
+/**
+ * @}
+ */
+
 //};
 
 #endif

Modified: trunk/lib/engine/display/skel/display-manager.h
==============================================================================
--- trunk/lib/engine/display/skel/display-manager.h	(original)
+++ trunk/lib/engine/display/skel/display-manager.h	Wed Jan 16 20:09:33 2008
@@ -40,7 +40,13 @@
 
 #include "display-core.h"
 
-namespace Ekiga {
+namespace Ekiga
+{
+
+/**
+ * @addtogroup display
+ * @{
+ */
 
   class DisplayManager
     {
@@ -61,8 +67,8 @@
        */               
 
       /** Create a call based on the remote uri given as parameter
-       * @param: An uri
-       * @return: true if a Ekiga::Call could be created
+       * @param uri  an uri
+       * @return     true if a Ekiga::Call could be created
        */
       virtual void start () { };
 
@@ -86,6 +92,11 @@
   protected:  
       virtual void get_display_info (DisplayInfo &) { };
     };
+
+/**
+ * @}
+ */
+
 };
 
 #endif

Modified: trunk/lib/engine/engine.h
==============================================================================
--- trunk/lib/engine/engine.h	(original)
+++ trunk/lib/engine/engine.h	Wed Jan 16 20:09:33 2008
@@ -40,10 +40,19 @@
 #include "services.h"
 #include "runtime.h"
 
+/**
+ * @addtogroup services
+ * @{
+ */
+
 void
 engine_init (int argc,
              char *argv[],
              Ekiga::Runtime *runtime,
              Ekiga::ServiceCore *& core);
 
+/**
+ * @}
+ */
+
 #endif

Modified: trunk/lib/engine/framework/form-builder.h
==============================================================================
--- trunk/lib/engine/framework/form-builder.h	(original)
+++ trunk/lib/engine/framework/form-builder.h	Wed Jan 16 20:09:33 2008
@@ -42,6 +42,12 @@
 
 namespace Ekiga
 {
+
+/**
+ * @addtogroup forms
+ * @{
+ */
+
   class FormBuilder: public virtual Form, public virtual FormVisitor
   {
   public:
@@ -236,5 +242,10 @@
     std::list<struct MultipleChoiceField> multiple_choices;
     std::list<struct EditableSetField> editable_sets;
   };
+
+/**
+ * @}
+ */
+
 };
 #endif

Modified: trunk/lib/engine/framework/form-dumper.h
==============================================================================
--- trunk/lib/engine/framework/form-dumper.h	(original)
+++ trunk/lib/engine/framework/form-dumper.h	Wed Jan 16 20:09:33 2008
@@ -44,6 +44,11 @@
 namespace Ekiga
 {
 
+/**
+ * @addtogroup forms
+ * @{
+ */
+
   class FormDumper: public FormVisitor
   {
   public:
@@ -94,6 +99,11 @@
 
     std::ostream &out;
   };
+
+/**
+ * @}
+ */
+
 };
 
 #endif

Modified: trunk/lib/engine/framework/form-request-simple.h
==============================================================================
--- trunk/lib/engine/framework/form-request-simple.h	(original)
+++ trunk/lib/engine/framework/form-request-simple.h	Wed Jan 16 20:09:33 2008
@@ -43,6 +43,12 @@
 
 namespace Ekiga
 {
+
+/**
+ * @addtogroup forms
+ * @{
+ */
+
   class FormRequestSimple: public FormRequest,
 			   public FormBuilder
   {
@@ -60,6 +66,11 @@
     sigc::signal<void, Form &> submitted;
 
   };
+
+/**
+ * @}
+ */
+
 };
 
 #endif

Modified: trunk/lib/engine/framework/form-request.h
==============================================================================
--- trunk/lib/engine/framework/form-request.h	(original)
+++ trunk/lib/engine/framework/form-request.h	Wed Jan 16 20:09:33 2008
@@ -40,6 +40,12 @@
 
 namespace Ekiga
 {
+
+/**
+ * @addtogroup forms
+ * @{
+ */
+
   class FormRequest: public virtual Form
   {
   public:
@@ -49,6 +55,11 @@
     virtual void submit (Form &) = 0;
 
   };
+
+/**
+ * @}
+ */
+
 };
 
 #endif

Modified: trunk/lib/engine/framework/form-visitor.h
==============================================================================
--- trunk/lib/engine/framework/form-visitor.h	(original)
+++ trunk/lib/engine/framework/form-visitor.h	Wed Jan 16 20:09:33 2008
@@ -42,6 +42,12 @@
 
 namespace Ekiga
 {
+
+/**
+ * @addtogroup forms
+ * @{
+ */
+
   class FormVisitor
   {
   public:
@@ -94,6 +100,11 @@
 			       const std::set<std::string> values,
 			       const std::set<std::string> proposed_values) = 0;
   };
+
+/**
+ * @}
+ */
+
 };
 
 #endif

Modified: trunk/lib/engine/framework/form.h
==============================================================================
--- trunk/lib/engine/framework/form.h	(original)
+++ trunk/lib/engine/framework/form.h	Wed Jan 16 20:09:33 2008
@@ -40,6 +40,12 @@
 
 namespace Ekiga
 {
+
+/**
+ * @defgroup forms Forms
+ * @{
+ */
+
   class Form
   {
   public:
@@ -80,6 +86,11 @@
 
     virtual const std::set<std::string> editable_set (const std::string name) const = 0;
   };
+
+/**
+ * @}
+ */
+
 };
 
 #endif

Modified: trunk/lib/engine/framework/lister.h
==============================================================================
--- trunk/lib/engine/framework/lister.h	(original)
+++ trunk/lib/engine/framework/lister.h	Wed Jan 16 20:09:33 2008
@@ -41,35 +41,8 @@
 #include "map-key-reference-iterator.h"
 #include "map-key-const-reference-iterator.h"
 
-
-/** Ekiga::List
- *
- * This class is there to help write a dynamic object lister, that is an object
- * which will more or less 'own' objects which will emit "updated" and
- * "removed" signals.
- *
- * The more or less means that it supports different memory management traits
- * using the second (optional) template argument :
- * - either no management (the default) ;
- * - or the object is considered fully owned, which will trigger its
- * destruction (using delete) when removed.
- *
- * You can remove an object from an Ekiga::Lister in two ways :
- * - either by calling the remove_object method,
- * - or by emission of the object's removed signal.
- *
- * Notice that this class won't take care of removing the object from a
- * backend -- only from the Ekiga::Lister.
- * If you want the object *deleted* from the real backend, then you
- * probably should have an organization like :
- * - the object has a 'deleted' signal ;
- * - the lister child-class listens to this signal ;
- * - when the signal is received, then do a remove_object followed by calling
- * the appropriate api function to delete the object in your backend.
- */
-
-
-namespace Ekiga {
+namespace Ekiga
+{
 
   template<typename ObjectType>
   struct no_object_management
@@ -88,6 +61,32 @@
 
   };
 
+  /** Ekiga::Lister
+   *
+   * This class is there to help write a dynamic object lister, that is an
+   * object which will more or less 'own' objects which will emit "updated"
+   * and "removed" signals.
+   *
+   * The more or less means that it supports different memory management
+   * traits using the second (optional) template argument:
+   *  - either no management (the default);
+   *  - or the object is considered fully owned, which will trigger its
+   *    destruction (using delete) when removed.
+   *
+   * You can remove an object from an Ekiga::Lister in two ways:
+   *  - either by calling the remove_object method,
+   *  - or by emission of the object's removed signal.
+   *
+   * Notice that this class won't take care of removing the object from a
+   * backend -- only from the Ekiga::Lister.
+   * If you want the object *deleted* from the real backend, then you
+   * probably should have an organization like:
+   *  - the object has a 'deleted' signal;
+   *  - the lister child-class listens to this signal;
+   *  - when the signal is received, then do a remove_object followed by
+   *    calling the appropriate api function to delete the object in your
+   *    backend.
+   */
   template<typename ObjectType,
 	   typename ObjectManagementTrait = no_object_management<ObjectType> >
   class Lister

Modified: trunk/lib/engine/framework/menu-builder.h
==============================================================================
--- trunk/lib/engine/framework/menu-builder.h	(original)
+++ trunk/lib/engine/framework/menu-builder.h	Wed Jan 16 20:09:33 2008
@@ -39,27 +39,38 @@
 #include <string>
 #include <sigc++/sigc++.h>
 
-/* This object serves to make objects toolkit-independent : an object can add
- * actions to a MenuBuilder, and the specific implementation will take care of
- * the GUI.
- * For example you can do in your GUI :
- * MyToolkitMenuType *menu = new MyToolkitMenuType(whatever);
- * MyMenuBuilder builder(menu);
- *
- * toolkit_independent_object.populate_menu (builder);
- *
- * now use builder->menu, which is toolkit-dependent!
- *
- * ! Notice !
- * You better be sure the toolkit_independent_object will still live when
- * using the obtained menu, or the user may trigger a now-dead action... for
- * example it could be an object with "removed"&"updated" signals, and you
- * watch those, which allow you to regenerate or discard the menu in due time.
- */
 
 namespace Ekiga
 {
 
+/**
+ * @defgroup actions Actions
+ * @{
+ */
+
+  /** Menu builder.
+   *
+   * This object serves to make objects toolkit-independent: an object can
+   * add actions to a MenuBuilder, and the specific implementation will
+   * take care of the GUI.
+   * For example you can do in your GUI:
+   * <pre>
+   *   MyToolkitMenuType *menu = new MyToolkitMenuType(whatever);
+   *   MyMenuBuilder builder(menu);
+   *
+   *   toolkit_independent_object.populate_menu (builder);
+   * </pre>
+   *
+   * now use builder->menu, which is toolkit-dependent!
+   *
+   * ! Notice !
+   * You better be sure the toolkit_independent_object will still live
+   * when using the obtained menu, or the user may trigger a now-dead
+   * action... for example it could be an object with "removed" &
+   * "updated" signals, and you watch those, which allow you to regenerate
+   * or discard the menu in due time.
+   */
+
   class MenuBuilder
   {
   public:
@@ -77,6 +88,10 @@
     virtual int size () const;
   };
 
+/**
+ * @}
+ */
+
 };
 
 #endif

Modified: trunk/lib/engine/framework/menu-xml.h
==============================================================================
--- trunk/lib/engine/framework/menu-xml.h	(original)
+++ trunk/lib/engine/framework/menu-xml.h	Wed Jan 16 20:09:33 2008
@@ -41,7 +41,7 @@
 #include "services.h"
 #include "menu-builder.h"
 
-/** FIXME: write a proper XML schema
+/* FIXME: write a proper XML schema
  * Here is how what a toolbar description looks like :
  * <toolbar>
  *   <item type="...">...</item>
@@ -60,10 +60,16 @@
  * - 'external' : the command will be run as a shell command
  * - 'internal' : the command will be interpreted as an Ekiga::Trigger to get
  *                (if the trigger isn't available, the item will be dropped)
- **/
+ */
 
 namespace Ekiga
 {
+
+/**
+ * @addtogroup actions
+ * @{
+ */
+
   class MenuXML
   {
   public:
@@ -80,6 +86,11 @@
     ServiceCore &core;
     xmlDocPtr doc;
   };
+
+/**
+ * @}
+ */
+
 };
 
 #endif

Modified: trunk/lib/engine/framework/runtime-glib.h
==============================================================================
--- trunk/lib/engine/framework/runtime-glib.h	(original)
+++ trunk/lib/engine/framework/runtime-glib.h	Wed Jan 16 20:09:33 2008
@@ -41,12 +41,18 @@
 #ifndef __RUNTIME_GLIB_H__
 #define __RUNTIME_GLIB_H__
 
-namespace Ekiga {
+namespace Ekiga
+{
+
+/**
+ * @addtogroup services
+ * @{
+ */
 
   class GlibRuntime
     : public Runtime
   {
-public:
+  public:
 
     GlibRuntime ();
 
@@ -59,10 +65,15 @@
     void run_in_main (sigc::slot<void> action,
                       unsigned int seconds);
 
-private:
+  private:
 
     GAsyncQueue *queue;
   };
+
+/**
+ * @}
+ */
+
 };
 
 #endif

Modified: trunk/lib/engine/framework/runtime.h
==============================================================================
--- trunk/lib/engine/framework/runtime.h	(original)
+++ trunk/lib/engine/framework/runtime.h	Wed Jan 16 20:09:33 2008
@@ -41,7 +41,13 @@
 
 #include "services.h"
 
-namespace Ekiga {
+namespace Ekiga
+{
+
+/**
+ * @addtogroup services
+ * @{
+ */
 
   class Runtime
     : public Service
@@ -67,6 +73,11 @@
     virtual void run_in_main (sigc::slot<void> action,
 			      unsigned int seconds = 0) = 0;
   };
+
+/**
+ * @}
+ */
+
 };
 
 #endif

Modified: trunk/lib/engine/framework/services.h
==============================================================================
--- trunk/lib/engine/framework/services.h	(original)
+++ trunk/lib/engine/framework/services.h	Wed Jan 16 20:09:33 2008
@@ -47,7 +47,13 @@
 #include <string>
 #include <sigc++/sigc++.h>
 
-namespace Ekiga {
+namespace Ekiga
+{
+
+/**
+ * @defgroup services Services
+ * @{
+ */
 
   struct Service
   {
@@ -80,6 +86,11 @@
     std::list<Service *> services;
 
   };
+
+/**
+ * @}
+ */
+
 };
 
 #endif

Modified: trunk/lib/engine/framework/trigger.h
==============================================================================
--- trunk/lib/engine/framework/trigger.h	(original)
+++ trunk/lib/engine/framework/trigger.h	Wed Jan 16 20:09:33 2008
@@ -38,7 +38,13 @@
 
 #include "services.h"
 
-namespace Ekiga {
+namespace Ekiga
+{
+
+/**
+ * @addtogroup services
+ * @{
+ */
 
   class Trigger: public Service
   {
@@ -48,6 +54,11 @@
 
     virtual void pull () = 0;
   };
+
+/**
+ * @}
+ */
+
 };
 
 #endif

Modified: trunk/lib/engine/presence/avahi/avahi-cluster.h
==============================================================================
--- trunk/lib/engine/presence/avahi/avahi-cluster.h	(original)
+++ trunk/lib/engine/presence/avahi/avahi-cluster.h	Wed Jan 16 20:09:33 2008
@@ -46,6 +46,7 @@
 
 /**
  * @addtogroup presence
+ * @internal
  * @{
  */
 

Modified: trunk/lib/engine/presence/avahi/avahi-heap.h
==============================================================================
--- trunk/lib/engine/presence/avahi/avahi-heap.h	(original)
+++ trunk/lib/engine/presence/avahi/avahi-heap.h	Wed Jan 16 20:09:33 2008
@@ -53,6 +53,7 @@
 
 /**
  * @addtogroup presence
+ * @internal
  * @{
  */
 

Modified: trunk/lib/engine/presence/avahi/avahi-presentity.h
==============================================================================
--- trunk/lib/engine/presence/avahi/avahi-presentity.h	(original)
+++ trunk/lib/engine/presence/avahi/avahi-presentity.h	Wed Jan 16 20:09:33 2008
@@ -48,6 +48,7 @@
 
 /**
  * @addtogroup presence
+ * @internal
  * @{
  */
 

Modified: trunk/lib/engine/presence/local-roster/local-cluster.h
==============================================================================
--- trunk/lib/engine/presence/local-roster/local-cluster.h	(original)
+++ trunk/lib/engine/presence/local-roster/local-cluster.h	Wed Jan 16 20:09:33 2008
@@ -44,6 +44,7 @@
 {
 /**
  * @addtogroup presence
+ * @internal
  * @{
  */
 

Modified: trunk/lib/engine/presence/local-roster/local-heap.h
==============================================================================
--- trunk/lib/engine/presence/local-roster/local-heap.h	(original)
+++ trunk/lib/engine/presence/local-roster/local-heap.h	Wed Jan 16 20:09:33 2008
@@ -33,19 +33,6 @@
  *
  */
 
-/**
- * This class implements an Ekiga::Heap.
- *
- * The Heap is internally represented by an XML document with all
- * presentities, and the groups they belong to.
- *
- * The parent class is responsible of emitting the appropriate
- * signals defined in heap.h through the use of global implementations
- * coded in heap-imp.h.
- *
- * When required, the Heap content is being saved in a GmConf entry.
- * Alternatively, it could be saved elsewhere.
- */
 
 #ifndef __LOCAL_HEAP_H__
 #define __LOCAL_HEAP_H__
@@ -60,9 +47,23 @@
 {
 /**
  * @addtogroup presence
+ * @internal
  * @{
  */
 
+  /**
+   * This class implements an Ekiga::Heap.
+   *
+   * The Heap is internally represented by an XML document with all
+   * presentities, and the groups they belong to.
+   *
+   * The parent class is responsible of emitting the appropriate
+   * signals defined in heap.h through the use of global implementations
+   * coded in heap-imp.h.
+   *
+   * When required, the Heap content is being saved in a GmConf entry.
+   * Alternatively, it could be saved elsewhere.
+   */
   class Heap : public Ekiga::HeapImpl<Presentity, Ekiga::delete_object_management <Presentity> >
   {
   public:

Modified: trunk/lib/engine/presence/local-roster/local-presentity.h
==============================================================================
--- trunk/lib/engine/presence/local-roster/local-presentity.h	(original)
+++ trunk/lib/engine/presence/local-roster/local-presentity.h	Wed Jan 16 20:09:33 2008
@@ -34,15 +34,6 @@
  */
 
 
-/**
- * This class implements an Ekiga::Presentity.
- *
- * The Presentity is represented by an internal XML document.
- *
- * There is a private signal, 'trigger_saving', which will be emitted
- * when appropriate to signal the Local::Heap that the XML tree has been
- * modified, and hence needs saving.
- */
 
 #ifndef __LOCAL_PRESENTITY_H__
 #define __LOCAL_PRESENTITY_H__
@@ -54,11 +45,22 @@
 
 namespace Local
 {
+
 /**
  * @addtogroup presence
+ * @internal
  * @{
  */
 
+  /**
+   * This class implements an Ekiga::Presentity.
+   *
+   * The Presentity is represented by an internal XML document.
+   *
+   * There is a private signal, 'trigger_saving', which will be emitted
+   * when appropriate to signal the Local::Heap that the XML tree has been
+   * modified, and hence needs saving.
+   */
   class Presentity: public Ekiga::Presentity
   {
   public:

Modified: trunk/lib/engine/presence/skel/cluster-impl.h
==============================================================================
--- trunk/lib/engine/presence/skel/cluster-impl.h	(original)
+++ trunk/lib/engine/presence/skel/cluster-impl.h	Wed Jan 16 20:09:33 2008
@@ -67,7 +67,7 @@
 
   };
 
-  /** Generic implementation for the Cluster pure virtual class.
+  /** Generic implementation for the Ekiga::Cluster abstract class.
    *
    * This class is there to make it easy to implement a new type of
    * cluster: it will take care of implementing the external api, you

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	Wed Jan 16 20:09:33 2008
@@ -45,7 +45,13 @@
 #include <map>
 
 
-namespace Ekiga {
+namespace Ekiga
+{
+
+/**
+ * @defgroup calls Calls and protocols
+ * @{
+ */
 
   class CallManager;
 
@@ -56,12 +62,12 @@
 
   public:
 
-      /* The constructor
-      */
+      /** The constructor
+       */
       CallCore () {}
 
-      /* The destructor
-      */
+      /** The destructor
+       */
       ~CallCore () {}
 
 
@@ -168,6 +174,11 @@
 
       std::set<CallManager *> managers;
     };
+
+/**
+ * @}
+ */
+
 };
 
 

Modified: trunk/lib/engine/protocol/skel/call-manager.h
==============================================================================
--- trunk/lib/engine/protocol/skel/call-manager.h	(original)
+++ trunk/lib/engine/protocol/skel/call-manager.h	Wed Jan 16 20:09:33 2008
@@ -42,7 +42,13 @@
 #include "call-core.h"
 #include "codec-description.h"
 
-namespace Ekiga {
+namespace Ekiga
+{
+
+/**
+ * @addtogroup calls
+ * @{
+ */
 
   class CallManager
     {
@@ -163,6 +169,11 @@
   private :
       std::string uri_type;
     };
+
+/**
+ * @}
+ */
+
 };
 
 #endif

Modified: trunk/lib/engine/protocol/skel/call.h
==============================================================================
--- trunk/lib/engine/protocol/skel/call.h	(original)
+++ trunk/lib/engine/protocol/skel/call.h	Wed Jan 16 20:09:33 2008
@@ -41,9 +41,15 @@
 #include <sigc++/sigc++.h>
 
 
-namespace Ekiga {
+namespace Ekiga
+{
 
-  /**
+/**
+ * @addtogroup calls
+ * @{
+ */
+
+  /*
    * Everything is handled asynchronously and signaled through the
    * Ekiga::CallManager
    */
@@ -259,6 +265,11 @@
       double late_packets; 
       double out_of_order_packets; 
     };
+
+/**
+ * @}
+ */
+
 };
 
 #endif

Modified: trunk/lib/engine/protocol/skel/codec-description.h
==============================================================================
--- trunk/lib/engine/protocol/skel/codec-description.h	(original)
+++ trunk/lib/engine/protocol/skel/codec-description.h	Wed Jan 16 20:09:33 2008
@@ -41,7 +41,13 @@
 
 #include <glib.h>
 
-namespace Ekiga {
+namespace Ekiga
+{
+
+/**
+ * @addtogroup calls
+ * @{
+ */
 
   /** This class holds the representation of a codec. 
    * That representation is different from the codec itself, but can be used
@@ -163,6 +169,11 @@
        */
       bool operator!= (const CodecList & c) const;
     };
+
+/**
+ * @}
+ */
+
 }
 
 /** Output the CodecList
[Date Prev][Date Next]   [Thread Prev][Thread Next]   [Thread Index] [Date Index] [Author Index]