- Add doxygen comments for all OpenChange server modules

- Fix doxygen return value for exchange_nsp

diff --git a/mapiproxy/servers/default/emsmdb/dcesrv_exchange_emsmdb.c b/mapiproxy/servers/default/emsmdb/dcesrv_exchange_emsmdb.c
index f60ceafde36b79a3f1392d86f49845d334c0624c..0b3f59b6b5fa90deb6577a5c18b139fb3b37de46 100644 (file)
--- a/mapiproxy/servers/default/emsmdb/dcesrv_exchange_emsmdb.c
+++ b/mapiproxy/servers/default/emsmdb/dcesrv_exchange_emsmdb.c
@@ -33,6 +33,12 @@
 
 /**
    \details exchange_emsmdb EcDoConnect (0x0) function
+
+   \param dce_call pointer to the session context
+   \param mem_ctx pointer to the memory context
+   \param r pointer to the EcDoConnect request data
+
+   \return MAPI_E_SUCCESS on success
  */
 static enum MAPISTATUS dcesrv_EcDoConnect(struct dcesrv_call_state *dce_call,
                                          TALLOC_CTX *mem_ctx,
@@ -45,6 +51,12 @@ static enum MAPISTATUS dcesrv_EcDoConnect(struct dcesrv_call_state *dce_call,
 
 /**
    \details exchange_emsmdb EcDoDisconnect (0x1) function
+
+   \param dce_call pointer to the session context
+   \param mem_ctx pointer to the memory context
+   \param r pointer to the EcDoDisconnect request data
+
+   \return MAPI_E_SUCCESS on success
  */
 static enum MAPISTATUS dcesrv_EcDoDisconnect(struct dcesrv_call_state *dce_call,
                                             TALLOC_CTX *mem_ctx,
@@ -57,6 +69,12 @@ static enum MAPISTATUS dcesrv_EcDoDisconnect(struct dcesrv_call_state *dce_call,
 
 /**
    \details exchange_emsmdb EcDoRpc (0x2) function
+
+   \param dce_call pointer to the session context
+   \param mem_ctx pointer to the memory context
+   \param r pointer to the EcDoRpc request data
+
+   \return MAPI_E_SUCCESS on success
  */
 static enum MAPISTATUS dcesrv_EcDoRpc(struct dcesrv_call_state *dce_call,
                                      TALLOC_CTX *mem_ctx,
@@ -69,6 +87,12 @@ static enum MAPISTATUS dcesrv_EcDoRpc(struct dcesrv_call_state *dce_call,
 
 /**
    \details exchange_emsmdb EcGetMoreRpc (0x3) function
+
+   \param dce_call pointer to the session context
+   \param mem_ctx pointer to the memory context
+   \param r pointer to the EcGetMoreRpc request data
+
+   \return MAPI_E_SUCCESS on success
  */
 static void dcesrv_EcGetMoreRpc(struct dcesrv_call_state *dce_call,
                                TALLOC_CTX *mem_ctx,
@@ -81,6 +105,12 @@ static void dcesrv_EcGetMoreRpc(struct dcesrv_call_state *dce_call,
 
 /**
    \details exchange_emsmdb EcRRegisterPushNotification (0x4) function
+
+   \param dce_call pointer to the session context
+   \param mem_ctx pointer to the memory context
+   \param r pointer to the EcRRegisterPushNotification request data
+
+   \return MAPI_E_SUCCESS on success
  */
 static enum MAPISTATUS dcesrv_EcRRegisterPushNotification(struct dcesrv_call_state *dce_call,
                                                          TALLOC_CTX *mem_ctx,
@@ -93,6 +123,12 @@ static enum MAPISTATUS dcesrv_EcRRegisterPushNotification(struct dcesrv_call_sta
 
 /**
    \details exchange_emsmdb EcRUnregisterPushNotification (0x5) function
+
+   \param dce_call pointer to the session context
+   \param mem_ctx pointer to the memory context
+   \param r pointer to the EcRUnregisterPushNotification request data
+
+   \return MAPI_E_SUCCESS on success
  */
 static enum MAPISTATUS dcesrv_EcRUnregisterPushNotification(struct dcesrv_call_state *dce_call,
                                                            TALLOC_CTX *mem_ctx,
@@ -105,6 +141,12 @@ static enum MAPISTATUS dcesrv_EcRUnregisterPushNotification(struct dcesrv_call_s
 
 /**
    \details exchange_emsmdb EcDummyRpc (0x6) function
+
+   \param dce_call pointer to the session context
+   \param mem_ctx pointer to the memory context
+   \param r pointer to the EcDummyRpc request data
+
+   \return MAPI_E_SUCCESS on success
  */
 static void dcesrv_EcDummyRpc(struct dcesrv_call_state *dce_call,
                              TALLOC_CTX *mem_ctx,
@@ -117,6 +159,12 @@ static void dcesrv_EcDummyRpc(struct dcesrv_call_state *dce_call,
 
 /**
    \details exchange_emsmdb EcRGetDCName (0x7) function
+
+   \param dce_call pointer to the session context
+   \param mem_ctx pointer to the memory context
+   \param r pointer to the EcRGetDCName request data
+
+   \return MAPI_E_SUCCESS on success
  */
 static void dcesrv_EcRGetDCName(struct dcesrv_call_state *dce_call,
                                TALLOC_CTX *mem_ctx,
@@ -129,6 +177,12 @@ static void dcesrv_EcRGetDCName(struct dcesrv_call_state *dce_call,
 
 /**
    \details exchange_emsmdb EcRNetGetDCName (0x8) function
+
+   \param dce_call pointer to the session context
+   \param mem_ctx pointer to the memory context
+   \param r pointer to the EcRNetGetDCName request data
+
+   \return MAPI_E_SUCCESS on success
  */
 static void dcesrv_EcRNetGetDCName(struct dcesrv_call_state *dce_call,
                                   TALLOC_CTX *mem_ctx,
@@ -141,6 +195,12 @@ static void dcesrv_EcRNetGetDCName(struct dcesrv_call_state *dce_call,
 
 /**
    \details exchange_emsmdb EcDoRpcExt (0x9) function
+
+   \param dce_call pointer to the session context
+   \param mem_ctx pointer to the memory context
+   \param r pointer to the EcDoRpcExt request data
+
+   \return MAPI_E_SUCCESS on success
  */
 static void dcesrv_EcDoRpcExt(struct dcesrv_call_state *dce_call,
                              TALLOC_CTX *mem_ctx,
@@ -153,6 +213,12 @@ static void dcesrv_EcDoRpcExt(struct dcesrv_call_state *dce_call,
 
 /**
    \details exchange_emsmdb EcDoConnectEx (0xA) function
+
+   \param dce_call pointer to the session context
+   \param mem_ctx pointer to the memory context
+   \param r pointer to the EcDoConnectEx request data
+
+   \return MAPI_E_SUCCESS on success
  */
 static enum MAPISTATUS dcesrv_EcDoConnectEx(struct dcesrv_call_state *dce_call,
                                            TALLOC_CTX *mem_ctx,
@@ -163,6 +229,18 @@ static enum MAPISTATUS dcesrv_EcDoConnectEx(struct dcesrv_call_state *dce_call,
 }
 
 
+/**
+   \details Dispatch incoming EMSMDB call to the correct OpenChange
+   server function
+
+   \param dce_call pointer to the session context
+   \param mem_ctx pointer to the memory context
+   \param r generic pointer on EMSMDB data
+   \param mapiproxy pointer to the mapiproxy structure controlling
+   mapiproxy behavior
+
+   \return NT_STATUS_OK;
+ */
 static NTSTATUS dcesrv_exchange_emsmdb_dispatch(struct dcesrv_call_state *dce_call,
                                                TALLOC_CTX *mem_ctx,
                                                void *r, struct mapiproxy *mapiproxy)
@@ -218,12 +296,27 @@ static NTSTATUS dcesrv_exchange_emsmdb_dispatch(struct dcesrv_call_state *dce_ca
 }
 
 
+/**
+   \details Initialize the EMSMDB OpenChange server
+
+   \param dce_ctx pointer to the server context
+
+   \return NT_STATUS_OK on success
+ */
 static NTSTATUS dcesrv_exchange_emsmdb_init(struct dcesrv_context *dce_ctx)
 {
        return NT_STATUS_OK;
 }
 
 
+/**
+   \details Terminate the EMSMDB connection
+
+   \param server_id reference to the server identifier structure
+   \param context_id the connection context identifier
+
+   \return NT_STATUS_OK on success
+ */
 static NTSTATUS dcesrv_exchange_emsmdb_unbind(struct server_id server_id, uint32_t context_id)
 {
        return NT_STATUS_OK;

diff --git a/mapiproxy/servers/default/nspi/dcesrv_exchange_nsp.c b/mapiproxy/servers/default/nspi/dcesrv_exchange_nsp.c
index 12ea1d04ec2da45b4c40e8612617a70fd9299431..b80e4a22d4d05f378c36a9793cf8d9c046644110 100644 (file)
--- a/mapiproxy/servers/default/nspi/dcesrv_exchange_nsp.c
+++ b/mapiproxy/servers/default/nspi/dcesrv_exchange_nsp.c
@@ -179,7 +179,7 @@ static enum MAPISTATUS dcesrv_NspiUnbind(struct dcesrv_call_state *dce_call,
    \param mem_ctx pointer to the memory context
    \param r pointer to the NspiUpdateStat request data
 
-   \return NT_STATUS_OK on success
+   \return MAPI_E_SUCCESS on success
 */
 static enum MAPISTATUS dcesrv_NspiUpdateStat(struct dcesrv_call_state *dce_call, 
                                             TALLOC_CTX *mem_ctx,
@@ -197,7 +197,7 @@ static enum MAPISTATUS dcesrv_NspiUpdateStat(struct dcesrv_call_state *dce_call,
    \param mem_ctx pointer to the memory context
    \param r pointer to the NspiQueryRows request data
 
-   \return NT_STATUS_OK on success
+   \return MAPI_E_SUCCESS on success
  */
 static enum MAPISTATUS dcesrv_NspiQueryRows(struct dcesrv_call_state *dce_call,
                                            TALLOC_CTX *mem_ctx,
@@ -215,7 +215,7 @@ static enum MAPISTATUS dcesrv_NspiQueryRows(struct dcesrv_call_state *dce_call,
    \param mem_ctx pointer to the memory context
    \param r pointer to the NspiSeekEntries request data
 
-   \return NT_STATUS_OK on success
+   \return MAPI_E_SUCCESS on success
  */
 static enum MAPISTATUS dcesrv_NspiSeekEntries(struct dcesrv_call_state *dce_call,
                                              TALLOC_CTX *mem_ctx,
@@ -233,7 +233,7 @@ static enum MAPISTATUS dcesrv_NspiSeekEntries(struct dcesrv_call_state *dce_call
    \param mem_ctx pointer to the memory context
    \param r pointer to the NspiGetMatches request data
 
-   \return NT_STATUS_OK on success
+   \return MAPI_E_SUCCESS on success
  */
 static enum MAPISTATUS dcesrv_NspiGetMatches(struct dcesrv_call_state *dce_call,
                                             TALLOC_CTX *mem_ctx,
@@ -251,7 +251,7 @@ static enum MAPISTATUS dcesrv_NspiGetMatches(struct dcesrv_call_state *dce_call,
    \param mem_ctx pointer to the memory context
    \param r pointer to the NspiResortRestriction request data
 
-   \return NT_STATUS_OK on success
+   \return MAPI_E_SUCCESS on success
  */
 static enum MAPISTATUS dcesrv_NspiResortRestriction(struct dcesrv_call_state *dce_call,
                                                    TALLOC_CTX *mem_ctx,
@@ -269,7 +269,7 @@ static enum MAPISTATUS dcesrv_NspiResortRestriction(struct dcesrv_call_state *dc
    \param mem_ctx pointer to the memory context
    \param r pointer to the NspiDNToMId request data
 
-   \return NT_STATUS_OK on success
+   \return MAPI_E_SUCCESS on success
  */
 static enum MAPISTATUS dcesrv_NspiDNToMId(struct dcesrv_call_state *dce_call,
                                          TALLOC_CTX *mem_ctx,
@@ -287,7 +287,7 @@ static enum MAPISTATUS dcesrv_NspiDNToMId(struct dcesrv_call_state *dce_call,
    \param mem_ctx pointer to the memory context
    \param r pointer to the NspiGetPropList request data
 
-   \return NT_STATUS_OK on success
+   \return MAPI_E_SUCCESS on success
  */
 static enum MAPISTATUS dcesrv_NspiGetPropList(struct dcesrv_call_state *dce_call,
                                              TALLOC_CTX *mem_ctx,
@@ -305,7 +305,7 @@ static enum MAPISTATUS dcesrv_NspiGetPropList(struct dcesrv_call_state *dce_call
    \param mem_ctx pointer to the memory context
    \param r pointer to the NspiGetProps request data
 
-   \return NT_STATUS_OK on success
+   \return MAPI_E_SUCCESS on success
  */
 static enum MAPISTATUS dcesrv_NspiGetProps(struct dcesrv_call_state *dce_call,
                                           TALLOC_CTX *mem_ctx,
@@ -323,7 +323,7 @@ static enum MAPISTATUS dcesrv_NspiGetProps(struct dcesrv_call_state *dce_call,
    \param mem_ctx pointer to the memory context
    \param r pointer to the NspiCompareMIds request data
 
-   \return NT_STATUS_OK on success
+   \return MAPI_E_SUCCESS on success
 */
 static enum MAPISTATUS dcesrv_NspiCompareMIds(struct dcesrv_call_state *dce_call,
                                              TALLOC_CTX *mem_ctx,
@@ -341,7 +341,7 @@ static enum MAPISTATUS dcesrv_NspiCompareMIds(struct dcesrv_call_state *dce_call
    \param mem_ctx pointer to the memory context
    \param r pointer to the NspiModProps request data
 
-   \return NT_STATUS_OK on success
+   \return MAPI_E_SUCCESS on success
 
  */
 static enum MAPISTATUS dcesrv_NspiModProps(struct dcesrv_call_state *dce_call,
@@ -360,7 +360,7 @@ static enum MAPISTATUS dcesrv_NspiModProps(struct dcesrv_call_state *dce_call,
    \param mem_ctx pointer to the memory context
    \param r pointer to the NspiGetSpecialTable request data
 
-   \return NT_STATUS_OK on success
+   \return MAPI_E_SUCCESS on success
 
  */
 static enum MAPISTATUS dcesrv_NspiGetSpecialTable(struct dcesrv_call_state *dce_call,
@@ -379,7 +379,7 @@ static enum MAPISTATUS dcesrv_NspiGetSpecialTable(struct dcesrv_call_state *dce_
    \param mem_ctx pointer to the memory context
    \param r pointer to the NspiGetTemplateInfo request data
 
-   \return NT_STATUS_OK on success
+   \return MAPI_E_SUCCESS on success
 
  */
 static enum MAPISTATUS dcesrv_NspiGetTemplateInfo(struct dcesrv_call_state *dce_call,
@@ -398,7 +398,7 @@ static enum MAPISTATUS dcesrv_NspiGetTemplateInfo(struct dcesrv_call_state *dce_
    \param mem_ctx pointer to the memory context
    \param r pointer to the NspiModLinkAtt request data
 
-   \return NT_STATUS_OK on success
+   \return MAPI_E_SUCCESS on success
 
  */
 static enum MAPISTATUS dcesrv_NspiModLinkAtt(struct dcesrv_call_state *dce_call,
@@ -417,7 +417,7 @@ static enum MAPISTATUS dcesrv_NspiModLinkAtt(struct dcesrv_call_state *dce_call,
    \param mem_ctx pointer to the memory context
    \param r pointer to the NspiDeleteEntries request data
 
-   \return NT_STATUS_OK on success
+   \return MAPI_E_SUCCESS on success
 
  */
 static enum MAPISTATUS dcesrv_NspiDeleteEntries(struct dcesrv_call_state *dce_call,
@@ -436,7 +436,7 @@ static enum MAPISTATUS dcesrv_NspiDeleteEntries(struct dcesrv_call_state *dce_ca
    \param mem_ctx pointer to the memory context
    \param r pointer to the NspiQueryColumns request data
 
-   \return NT_STATUS_OK on success
+   \return MAPI_E_SUCCESS on success
 
  */
 static enum MAPISTATUS dcesrv_NspiQueryColumns(struct dcesrv_call_state *dce_call,
@@ -455,7 +455,7 @@ static enum MAPISTATUS dcesrv_NspiQueryColumns(struct dcesrv_call_state *dce_cal
    \param mem_ctx pointer to the memory context
    \param r pointer to the NspiGetNamesFromIDs request data
 
-   \return NT_STATUS_OK on success
+   \return MAPI_E_SUCCESS on success
 
  */
 static enum MAPISTATUS dcesrv_NspiGetNamesFromIDs(struct dcesrv_call_state *dce_call,
@@ -474,7 +474,7 @@ static enum MAPISTATUS dcesrv_NspiGetNamesFromIDs(struct dcesrv_call_state *dce_
    \param mem_ctx pointer to the memory context
    \param r pointer to the NspiGetIDsFromNames request data
 
-   \return NT_STATUS_OK on success
+   \return MAPI_E_SUCCESS on success
 
  */
 static enum MAPISTATUS dcesrv_NspiGetIDsFromNames(struct dcesrv_call_state *dce_call,
@@ -493,7 +493,7 @@ static enum MAPISTATUS dcesrv_NspiGetIDsFromNames(struct dcesrv_call_state *dce_
    \param mem_ctx pointer to the memory context
    \param r pointer to the NspiResolveNames request data
 
-   \return NT_STATUS_OK on success
+   \return MAPI_E_SUCCESS on success
 
  */
 static enum MAPISTATUS dcesrv_NspiResolveNames(struct dcesrv_call_state *dce_call,
@@ -512,7 +512,7 @@ static enum MAPISTATUS dcesrv_NspiResolveNames(struct dcesrv_call_state *dce_cal
    \param mem_ctx pointer to the memory context
    \param r pointer to the NspiResolveNamesW request data
 
-   \return NT_STATUS_OK on success
+   \return MAPI_E_SUCCESS on success
 
  */
 static enum MAPISTATUS dcesrv_NspiResolveNamesW(struct dcesrv_call_state *dce_call,

diff --git a/mapiproxy/servers/default/rfr/dcesrv_exchange_ds_rfr.c b/mapiproxy/servers/default/rfr/dcesrv_exchange_ds_rfr.c
index 1c2452cbfbe3041825637ac4287fd1b1e39c8b06..9d4c31b0326a303c46c49eeab98c226be21fee95 100644 (file)
--- a/mapiproxy/servers/default/rfr/dcesrv_exchange_ds_rfr.c
+++ b/mapiproxy/servers/default/rfr/dcesrv_exchange_ds_rfr.c
@@ -33,6 +33,12 @@
 
 /**
    \details exchange_ds_rfr RfrGetNewDSA (0x0) function
+
+   \param dce_call pointer to the session context
+   \param mem_ctx pointer to the memory context
+   \param r pointer to the RfrGetNewDSA request data
+
+   \return MAPI_E_SUCCESS on success
  */
 static enum MAPISTATUS dcesrv_RfrGetNewDSA(struct dcesrv_call_state *dce_call,
                                           TALLOC_CTX *mem_ctx,
@@ -45,6 +51,12 @@ static enum MAPISTATUS dcesrv_RfrGetNewDSA(struct dcesrv_call_state *dce_call,
 
 /**
    \details exchange_ds_rrf RfrGetFQDNFromLegacyDN (0x1) function
+
+   \param dce_call pointer to the session context
+   \param mem_ctx pointer to the memory context
+   \param r pointer to the RfrGetFQDNFromLegacyDN request data
+
+   \return MAPI_E_SUCCESS on success
  */
 static enum MAPISTATUS dcesrv_RfrGetFQDNFromLegacyDN(struct dcesrv_call_state *dce_call,
                                                     TALLOC_CTX *mem_ctx,
@@ -55,6 +67,17 @@ static enum MAPISTATUS dcesrv_RfrGetFQDNFromLegacyDN(struct dcesrv_call_state *d
 }
 
 
+/**
+   \details Dispatch incoming RFR call to the correct OpenChange server function
+
+   \param dce_call pointer to the session context
+   \param mem_ctx pointer to the memory context
+   \param r generic pointer on RFR data
+   \param mapiproxy pointer to the mapiproxy structure controlling
+   mapiproxy behavior
+
+   \return NT_STATUS_OK
+ */
 static NTSTATUS dcesrv_exchange_ds_rfr_dispatch(struct dcesrv_call_state *dce_call,
                                                TALLOC_CTX *mem_ctx,
                                                void *r, struct mapiproxy *mapiproxy)
@@ -84,12 +107,27 @@ static NTSTATUS dcesrv_exchange_ds_rfr_dispatch(struct dcesrv_call_state *dce_ca
 }
 
 
+/**
+   \details Initialize the RFR OpenChange server
+
+   \param dce_ctx pointer to the server context
+
+   \return NT_STATUS_OK on success
+ */
 static NTSTATUS dcesrv_exchange_ds_rfr_init(struct dcesrv_context *dce_ctx)
 {
        return NT_STATUS_OK;
 }
 
 
+/**
+   \details Terminate the RFR connection
+
+   \param server_id reference to the server identifier structure
+   \param context_id the connection context identifier
+
+   \return NT_STATUS_OK on success
+ */
 static NTSTATUS dcesrv_exchange_ds_rfr_unbind(struct server_id server_id, 
                                              uint32_t context_id)
 {