qthighway/xqserviceipc/xqserviceipcserver/xqserviceipcserverprivate.h
changeset 24 9d760f716ca8
parent 1 2b40d63a9c3d
--- a/qthighway/xqserviceipc/xqserviceipcserver/xqserviceipcserverprivate.h	Wed Aug 18 10:38:12 2010 +0300
+++ b/qthighway/xqserviceipc/xqserviceipcserver/xqserviceipcserverprivate.h	Thu Sep 02 21:20:48 2010 +0300
@@ -33,10 +33,12 @@
     class ServiceIPCSession;
     class MServiceIPCObserver;
 
-    /**
-     *  Private implementation interface for service framework server
-     *  This class is the abstract interface for all server backends
-     */
+    /*!
+        \class ServiceFwIPCServerPrivate
+        \brief Private implementation interface for service framework server
+        
+        This class is the abstract interface for all server backends.
+    */
     class ServiceFwIPCServerPrivate : public QObjectPrivate
         {
     protected:
@@ -44,24 +46,23 @@
 
     public:
 
-        /**
-        * Start listening for new service requests
-        * @param aServerName name of the server
-        * @return true if listen was successful
+        /*!
+            Start listening for new service requests.
+            \param aServerName Name of the server.
+            \return true if listen was successful.
         */
         virtual bool listen( const QString& aServerName ) = 0;
 
-        /**
-        * Shutdown the server and stop serving clients 
-        * @return void
+        /*!
+            Shutdown the server and stop serving clients.
         */
         virtual void disconnect() = 0;
 
     protected:
 
-        /**
-        * Get the server observer
-        * @return MServiceIPCObserver* observer to this server
+        /*!
+            Get the server observer.
+            \return MServiceIPCObserver* observer to this server.
         */
         inline MServiceIPCObserver* Observer() { Q_Q(ServiceFwIPCServer); return q->iObserver; };