Modules for Rnprotocol

7 files changed, 81 insertions, 1 deletions

diff --git a/rnprotocol/rnpclientcomm.hh b/rnprotocol/rnpclientcomm.hh
index cd81edd..87f7dba 100644
--- a/rnprotocol/rnpclientcomm.hh
+++ b/rnprotocol/rnpclientcomm.hh
@@ -36,6 +36,14 @@ rasdaman GmbH.
 
 using namespace rnp;
 
+/**
+  * \defgroup Rnprotocols Rnprotocol Classes
+  */
+
+/**
+  * \ingroup Rnprotocols
+  */
+ 
 class RnpClientComm : public ClientComm, RnpBaseClientComm
   {
     public:
diff --git a/rnprotocol/rnpcommunication.hh b/rnprotocol/rnpcommunication.hh
index 56aca81..4b0bb7f 100644
--- a/rnprotocol/rnpcommunication.hh
+++ b/rnprotocol/rnpcommunication.hh
@@ -52,6 +52,10 @@ class RnpBaseClientComm;
     and receives the answer. Is directy owned and used by 'RnpBaseClientComm',
     so you don't have to worry about it
     Be aware that the transmitter buffer is freed after transmission! */
+
+/**
+  * \ingroup Rnprotocols
+  */
 class RnpClientJob : public NbClientJob
   {
     public:
@@ -106,6 +110,10 @@ class RnpClientJob : public NbClientJob
   It has a private NbCommunicator object, but if you need a shared one
   be my guest. The RnpClientJob is its own also and this stays like that!
 */
+
+/**
+  * \ingroup Rnprotocols
+  */
 class RnpBaseClientComm
   {
     public:
@@ -200,6 +208,10 @@ class RnpBaseServerComm;
 /** This class represents the RNP server job. It receives the request, sends it to 'RnpBaseServerComm'
     for processing and gets from there the answer which it transmittes to the client
 */
+
+/**
+  * \ingroup Rnprotocols
+  */
 class RnpServerJob : public NbServerJob
   {
     public:
@@ -242,6 +254,9 @@ class RnpServerJob : public NbServerJob
   a valid request calls 'processRequest()'. The communicator object is external
 */
 
+/**
+  * \ingroup Rnprotocols
+  */
 class RnpBaseServerComm
   {
     public:
diff --git a/rnprotocol/rnpembedded.hh b/rnprotocol/rnpembedded.hh
index 2e7c454..60fdc0c 100644
--- a/rnprotocol/rnpembedded.hh
+++ b/rnprotocol/rnpembedded.hh
@@ -42,6 +42,10 @@ namespace rnp
 
 /** Class containing definitions and some helper functions
 */
+
+/**
+  * \ingroup Rnprotocols
+  */
 class RnpTransport
   {
     public:
@@ -72,6 +76,9 @@ class RnpTransport
   The receiver has two buffers, a fixed length one, for header and a dynamic one for the RNP message  
 */
 
+/**
+  * \ingroup Rnprotocols
+  */
 class RnpReceiver
   {
     public:
@@ -141,6 +148,10 @@ class RnpCarrier;
     from RnpProtocolEncoder, it offers just convenient methods for 
     dealing with carriers
 */
+
+/**
+  * \ingroup Rnprotocols
+  */
 class RnpTransmitter : public RnpProtocolEncoder
   {
     public:
@@ -184,6 +195,10 @@ class RnpTransmitter : public RnpProtocolEncoder
 
 /** Base class for the various carriers, is itself the RNP carrier
 */
+
+/**
+  * \ingroup Rnprotocols
+  */
 class RnpCarrier
   {
     public:
@@ -217,6 +232,10 @@ class RnpCarrier
 
 /** The HTTP-carrier
 */
+
+/**
+  * \ingroup Rnprotocols
+  */
 class HttpRnpCarrier : public RnpCarrier
   {
     public:
@@ -239,6 +258,10 @@ class HttpRnpCarrier : public RnpCarrier
 
 /** A 'bad carrier', just for testing purposes
 */
+
+/**
+  * \ingroup Rnprotocols
+  */
 class BadRnpCarrier : public RnpCarrier
   {
     public:
diff --git a/rnprotocol/rnprasserver.hh b/rnprotocol/rnprasserver.hh
index 44b6473..f5f031a 100644
--- a/rnprotocol/rnprasserver.hh
+++ b/rnprotocol/rnprasserver.hh
@@ -27,6 +27,10 @@ rasdaman GmbH.
 
 using namespace rnp;
 
+
+/**
+  * \ingroup Rnprotocols
+  */
 class RnpRasserver : public Rnp
   {
     public:
diff --git a/rnprotocol/rnprotocol.hh b/rnprotocol/rnprotocol.hh
index dfa7885..494dc91 100644
--- a/rnprotocol/rnprotocol.hh
+++ b/rnprotocol/rnprotocol.hh
@@ -52,6 +52,10 @@ typedef int RnpQuark;
 
 /** Class Rnp contains definitions and general helper functions for RNP
 */
+
+/**
+  * \ingroup Rnprotocols
+  */
 class Rnp
   {
    public:
@@ -253,6 +257,10 @@ struct RnpFragmentHeader
     creating the message into a akg::CommBuffer, which can be internal or external.
     The buffer has to be big enough, the size is not adapted
 */
+
+/**
+  * \ingroup Rnprotocols
+  */
 class RnpProtocolEncoder
   {
     public:
@@ -347,6 +355,10 @@ class RnpProtocolEncoder
 /** Class for decoding a RNP message. The buffer is always an external one
     Decoding the messsage means also changing the endianness to the host endianness
 */
+
+/**
+  * \ingroup Rnprotocols
+  */
 class RnpProtocolDecoder
   {
     public:
diff --git a/rnprotocol/rnpservercomm.hh b/rnprotocol/rnpservercomm.hh
index 9a173f4..c822873 100644
--- a/rnprotocol/rnpservercomm.hh
+++ b/rnprotocol/rnpservercomm.hh
@@ -40,6 +40,10 @@ rasdaman GmbH.
 
 using namespace rnp;
 
+
+/**
+  * \ingroup Rnprotocols
+  */
 class ClientTimer
   {
     public:
@@ -52,7 +56,10 @@ class ClientTimer
       time_t lastAction;
       bool   enabled;
    };
-   
+
+/**
+  * \ingroup Rnprotocols
+  */   
 class RnpRasserverJob : public RnpServerJob
   {
     public:
@@ -67,6 +74,10 @@ class RnpRasserverJob : public RnpServerJob
       void executeOnWriteError() throw();
    };
    
+
+/**
+  * \ingroup Rnprotocols
+  */
 class RnpRasDaManComm : public RnpBaseServerComm
   {
     public:
@@ -142,6 +153,10 @@ class RnpRasDaManComm : public RnpBaseServerComm
       static const int NoClient;
     };
 
+
+/**
+  * \ingroup Rnprotocols
+  */
 class RasserverCommunicator : public NbCommunicator
   {
     public:
diff --git a/rnprotocol/srvrasmgrcomm.hh b/rnprotocol/srvrasmgrcomm.hh
index 0d15c4c..8a8b81f 100644
--- a/rnprotocol/srvrasmgrcomm.hh
+++ b/rnprotocol/srvrasmgrcomm.hh
@@ -39,6 +39,9 @@ rasdaman GmbH.
     // regularly signal the rasmgr that we are available
 #define SERVER_REGULARSIG  3
 
+/**
+  * \ingroup Rnprotocols
+  */
 class SrvRasmgrComm
   {
     public: