G'day,
Please find enclosed a little update for some API dox.
Please apply.
Thanks
Brad
Index: libmapi/simple_mapi.c
===================================================================
--- libmapi/simple_mapi.c (revision 348)
+++ libmapi/simple_mapi.c (working copy)
@@ -25,7 +25,7 @@
/**
\file simple_mapi.c
- \brief Convenient functions.
+ \brief Convenience functions.
*/
Index: libmapi/mapi_nameid.c
===================================================================
--- libmapi/mapi_nameid.c (revision 348)
+++ libmapi/mapi_nameid.c (working copy)
@@ -25,12 +25,12 @@
/**
\file mapi_nameid.c
- \brief mapi_nameid convenient API
+ \brief mapi_nameid convenience API
*/
/**
- \details Create a new mapi_newid structure
+ \details Create a new mapi_nameid structure
\param mem_ctx memory context to use for allocation
@@ -70,7 +70,7 @@
\note Developers should call GetLastError() to retrieve the last
MAPI error code. Possible MAPI error codes are:
- MAPI_E_NOT_INITIALIZED: MAPI subsystem has not been initialized
- - MAPI_E_INVALID_PARAMETER: one of the parameter was not set
+ - MAPI_E_INVALID_PARAMETER: one of the parameters was not set
properly
- MAPI_E_NOT_FOUND: the entry intended to be added was not found
@@ -137,7 +137,7 @@
\note Developers should call GetLastError() to retrieve the last
MAPI error code. Possible MAPI error codes are:
- MAPI_E_NOT_INITIALIZED: MAPI subsystem has not been initialized
- - MAPI_E_INVALID_PARAMETER: one of the parameter was not set
+ - MAPI_E_INVALID_PARAMETER: one of the parameters was not set
properly
- MAPI_E_NOT_FOUND: the entry intended to be added was not found
@@ -202,7 +202,7 @@
\note Developers should call GetLastError() to retrieve the last
MAPI error code. Possible MAPI error codes are:
- MAPI_E_NOT_INITIALIZED: MAPI subsystem has not been initialized
- - MAPI_E_INVALID_PARAMETER: one of the parameter was not set
+ - MAPI_E_INVALID_PARAMETER: one of the parameters was not set
properly
- MAPI_E_NOT_FOUND: the entry intended to be added was not found
@@ -267,7 +267,7 @@
\note Developers should call GetLastError() to retrieve the last
MAPI error code. Possible MAPI error codes are:
- - MAPI_E_INVALID_PARAMETER: one of the parameter was not set
+ - MAPI_E_INVALID_PARAMETER: one of the parameters was not set
properly
\sa GetIDsFromNames
@@ -301,7 +301,7 @@
\note Developers should call GetLastError() to retrieve the last
MAPI error code. Possible MAPI error codes are:
- - MAPI_E_INVALID_PARAMETER: one of the parameter was not set
+ - MAPI_E_INVALID_PARAMETER: one of the parameters was not set
properly
\sa GetIDsFromNames, mapi_nameid_SPropTagArray
Index: libmapi/lzfu.c
===================================================================
--- libmapi/lzfu.c (revision 348)
+++ libmapi/lzfu.c (working copy)
@@ -25,7 +25,7 @@
/**
\file lzfu.c
- \brief RTF Compressed related functions
+ \brief Compressed RTF related functions
*/
Index: libmapi/IMAPIFolder.c
===================================================================
--- libmapi/IMAPIFolder.c (revision 348)
+++ libmapi/IMAPIFolder.c (working copy)
@@ -24,6 +24,8 @@
/**
\file IMAPIFolder.c
+
+ \brief Folder related functions
*/
Index: libmapi/IMessage.c
===================================================================
--- libmapi/IMessage.c (revision 348)
+++ libmapi/IMessage.c (working copy)
@@ -26,6 +26,8 @@
/**
\file IMessage.c
+
+ \brief Operations on messages
*/
Index: libmapi/IMAPISession.c
===================================================================
--- libmapi/IMAPISession.c (revision 348)
+++ libmapi/IMAPISession.c (working copy)
@@ -24,6 +24,8 @@
/**
\file IMAPISession.c
+
+ \brief Session initialization options
*/
@@ -31,7 +33,7 @@
\details Open the Public Folder store
This function opens the public folder store. This allows access to
- the normal folders.
+ the public folders.
\param obj_store the result of opening the store
@@ -125,7 +127,7 @@
\details Open the Message Store
This function opens the main message store. This allows access to
- the normal folders.
+ the normal user folders.
\param obj_store the result of opening the store
_______________________________________________
devel mailing list
[email protected]
http://mailman.openchange.org/listinfo/devel
