ole32: improve c2man documentation
Markus Amsler
markus.amsler at oribi.org
Tue Nov 8 19:27:10 CST 2005
This patch improves the c2man Documented-Total count of ole32 from
70(44%) to 73(45%), of compobj from 5(12%) to 7(17%) and of ole2 from
3(10%) to 5 (17%).
Changelog:
Markus Amsler <markus.amsler at oribi.org>
Improve c2man Documented-Total count.
-------------- next part --------------
Index: dlls/ole32/clipboard.c
===================================================================
RCS file: /home/wine/wine/dlls/ole32/clipboard.c,v
retrieving revision 1.46
diff -u -r1.46 clipboard.c
--- dlls/ole32/clipboard.c 25 Sep 2005 15:17:10 -0000 1.46
+++ dlls/ole32/clipboard.c 9 Nov 2005 01:25:25 -0000
@@ -303,7 +303,7 @@
* Places a pointer to the specified data object onto the clipboard,
* making the data object accessible to the OleGetClipboard function.
*
- * RETURNS:
+ * RETURNS
*
* S_OK IDataObject pointer placed on the clipboard
* CLIPBRD_E_CANT_OPEN OpenClipboard failed
Index: dlls/ole32/memlockbytes16.c
===================================================================
RCS file: /home/wine/wine/dlls/ole32/memlockbytes16.c,v
retrieving revision 1.14
diff -u -r1.14 memlockbytes16.c
--- dlls/ole32/memlockbytes16.c 24 Jul 2005 16:15:24 -0000 1.14
+++ dlls/ole32/memlockbytes16.c 9 Nov 2005 01:25:25 -0000
@@ -500,12 +500,12 @@
*
* Creates an ILockBytes interface for a HGLOBAL handle.
*
- * Params:
+ * PARAMS
* hGlobal the global handle (16bit)
* fDeleteOnRelease delete handle on release.
* ppLkbyt pointer to ILockBytes interface.
*
- * Returns:
+ * RETURNS
* Staddard OLE error return codes.
*
*/
Index: dlls/ole32/ole16.c
===================================================================
RCS file: /home/wine/wine/dlls/ole32/ole16.c,v
retrieving revision 1.22
diff -u -r1.22 ole16.c
--- dlls/ole32/ole16.c 25 Sep 2005 15:17:10 -0000 1.22
+++ dlls/ole32/ole16.c 9 Nov 2005 01:25:25 -0000
@@ -204,6 +204,9 @@
/***********************************************************************
* CoGetMalloc [COMPOBJ.4]
+ *
+ * Retrieve the current win16 IMalloc interface.
+ *
* RETURNS
* The current win16 IMalloc
*/
@@ -344,9 +347,12 @@
/******************************************************************************
* ProgIDFromCLSID [COMPOBJ.62]
+ *
* Converts a class id into the respective Program ID. (By using a registry lookup)
- * RETURNS S_OK on success
- * riid associated with the progid
+ *
+ * RETURNS
+ * S_OK on success
+ * riid associated with the progid
*/
HRESULT WINAPI ProgIDFromCLSID16(
REFCLSID clsid, /* [in] class id as found in registry */
Index: dlls/ole32/ole2.c
===================================================================
RCS file: /home/wine/wine/dlls/ole32/ole2.c,v
retrieving revision 1.77
diff -u -r1.77 ole2.c
--- dlls/ole32/ole2.c 25 Sep 2005 15:17:10 -0000 1.77
+++ dlls/ole32/ole2.c 9 Nov 2005 01:25:25 -0000
@@ -1567,21 +1567,23 @@
/***********************************************************************
* OleSetMenuDescriptor [OLE32.@]
- * Installs or removes OLE dispatching code for the containers frame window
- * FIXME: The lpFrame and lpActiveObject parameters are currently ignored
- * OLE should install context sensitive help F1 filtering for the app when
- * these are non null.
+ * Installs or removes OLE dispatching code for the containers frame window.
*
- * PARAMS:
+ * PARAMS
* hOleMenu Handle to composite menu descriptor
* hwndFrame Handle to containers frame window
* hwndActiveObject Handle to objects in-place activation window
* lpFrame Pointer to IOleInPlaceFrame on containers window
* lpActiveObject Pointer to IOleInPlaceActiveObject on active in-place object
*
- * RETURNS:
+ * RETURNS
* S_OK - menu installed correctly
* E_FAIL, E_INVALIDARG, E_UNEXPECTED - failure
+ *
+ * FIXME
+ * The lpFrame and lpActiveObject parameters are currently ignored
+ * OLE should install context sensitive help F1 filtering for the app when
+ * these are non null.
*/
HRESULT WINAPI OleSetMenuDescriptor(
HOLEMENU hOleMenu,
Index: dlls/ole32/storage.c
===================================================================
RCS file: /home/wine/wine/dlls/ole32/storage.c,v
retrieving revision 1.51
diff -u -r1.51 storage.c
--- dlls/ole32/storage.c 16 Aug 2005 16:01:15 -0000 1.51
+++ dlls/ole32/storage.c 9 Nov 2005 01:25:26 -0000
@@ -2227,7 +2227,12 @@
* the WriteClassStg.
*
* PARAMS
- * pstg Segmented LPSTORAGE pointer.
+ * pstg [I] Segmented LPSTORAGE pointer.
+ * pclsid [O] Pointer to where the CLSID is written
+ *
+ * RETURNS
+ * Success: S_OK.
+ * Failure: HRESULT code.
*/
HRESULT WINAPI ReadClassStg16(SEGPTR pstg, CLSID *pclsid)
{
Index: dlls/ole32/storage32.c
===================================================================
RCS file: /home/wine/wine/dlls/ole32/storage32.c,v
retrieving revision 1.95
diff -u -r1.95 storage32.c
--- dlls/ole32/storage32.c 22 Sep 2005 10:34:40 -0000 1.95
+++ dlls/ole32/storage32.c 9 Nov 2005 01:25:28 -0000
@@ -6140,7 +6140,16 @@
/***********************************************************************
* ReadClassStg (OLE32.@)
*
- * This method reads the CLSID previously written to a storage object with the WriteClassStg.
+ * This method reads the CLSID previously written to a storage object with
+ * the WriteClassStg.
+ *
+ * PARAMS
+ * pstg [I] IStorage pointer
+ * pclsid [O] Pointer to where the CLSID is written
+ *
+ * RETURNS
+ * Success: S_OK.
+ * Failure: HRESULT code.
*/
HRESULT WINAPI ReadClassStg(IStorage *pstg,CLSID *pclsid){
More information about the wine-patches
mailing list