Tweak documentation to silence winapi_check
Francois Gouget
fgouget at free.fr
Wed Apr 20 09:52:38 CDT 2005
winapi_check is easily confused when parsing the API documentation. So
this patch contains small tweaks to silence spurious warnings so that
the winapi_check output is smaller and cleaner. Hopefully this will make
it easier for others to identify and fix the other more important issues
reported by winapi_check.
Changelog:
* dlls/advapi32/crypt.c
dlls/advapi32/security.c
dlls/gdi/palette.c
dlls/mshtml/main.c
dlls/msi/action.c
dlls/msi/msi.c
dlls/ole32/ole2.c
dlls/rpcrt4/rpcrt4_main.c
dlls/user/misc.c
dlls/wininet/ftp.c
dlls/x11drv/xrender.c
Francois Gouget <fgouget at free.fr>
Tweak the API documentation to silence winapi_check warnings.
--
Francois Gouget fgouget at free.fr http://fgouget.free.fr/
The nice thing about meditation is that it makes doing nothing quite respectable
-- Paul Dean
-------------- next part --------------
Index: dlls/advapi32/crypt.c
===================================================================
RCS file: /var/cvs/wine/dlls/advapi32/crypt.c,v
retrieving revision 1.63
diff -u -p -r1.63 crypt.c
--- dlls/advapi32/crypt.c 11 Apr 2005 12:55:36 -0000 1.63
+++ dlls/advapi32/crypt.c 20 Apr 2005 09:37:20 -0000
@@ -1899,6 +1899,8 @@ BOOL WINAPI CryptVerifySignatureA (HCRYP
/******************************************************************************
* SystemFunction040 (ADVAPI32.@)
*
+ * MSDN documents this function as RtlEncryptMemory.
+ *
* PARAMS
* memory [I/O] Pointer to memory to encrypt.
* length [I] Length of region to encrypt in bytes.
@@ -1912,7 +1914,7 @@ BOOL WINAPI CryptVerifySignatureA (HCRYP
* If flags are specified when encrypting, the same flag value must be given
* when decrypting the memory.
*/
-NTSTATUS WINAPI SystemFunction040(PVOID memory, ULONG length, ULONG flags) /* RtlEncryptMemory */
+NTSTATUS WINAPI SystemFunction040(PVOID memory, ULONG length, ULONG flags)
{
FIXME("(%p, %lx, %lx): stub [RtlEncryptMemory]\n", memory, length, flags);
return STATUS_SUCCESS;
@@ -1921,6 +1923,8 @@ NTSTATUS WINAPI SystemFunction040(PVOID
/******************************************************************************
* SystemFunction041 (ADVAPI32.@)
*
+ * MSDN documents this function as RtlDecryptMemory.
+ *
* PARAMS
* memory [I/O] Pointer to memory to decrypt.
* length [I] Length of region to decrypt in bytes.
@@ -1934,7 +1938,7 @@ NTSTATUS WINAPI SystemFunction040(PVOID
* If flags are specified when encrypting, the same flag value must be given
* when decrypting the memory.
*/
-NTSTATUS WINAPI SystemFunction041(PVOID memory, ULONG length, ULONG flags) /* RtlDecryptMemory */
+NTSTATUS WINAPI SystemFunction041(PVOID memory, ULONG length, ULONG flags)
{
FIXME("(%p, %lx, %lx): stub [RtlDecryptMemory]\n", memory, length, flags);
return STATUS_SUCCESS;
Index: dlls/advapi32/security.c
===================================================================
RCS file: /var/cvs/wine/dlls/advapi32/security.c,v
retrieving revision 1.99
diff -u -p -r1.99 security.c
--- dlls/advapi32/security.c 13 Apr 2005 11:02:59 -0000 1.99
+++ dlls/advapi32/security.c 20 Apr 2005 09:39:26 -0000
@@ -1673,6 +1673,9 @@ LsaQueryInformationPolicy(
return TRUE;
}
+/******************************************************************************
+ * LsaSetInformationPolicy [ADVAPI32.@]
+ */
NTSTATUS WINAPI
LsaSetInformationPolicy(
LSA_HANDLE PolicyHandle,
@@ -1937,6 +1940,9 @@ LookupAccountNameA(
return ret;
}
+/******************************************************************************
+ * LookupAccountNameW [ADVAPI32.@]
+ */
BOOL WINAPI LookupAccountNameW( LPCWSTR lpSystemName, LPCWSTR lpAccountName, PSID Sid,
LPDWORD cbSid, LPWSTR ReferencedDomainName,
LPDWORD cchReferencedDomainName, PSID_NAME_USE peUse )
Index: dlls/gdi/palette.c
===================================================================
RCS file: /var/cvs/wine/dlls/gdi/palette.c,v
retrieving revision 1.7
diff -u -p -r1.7 palette.c
--- dlls/gdi/palette.c 30 Mar 2005 17:08:34 -0000 1.7
+++ dlls/gdi/palette.c 20 Apr 2005 09:45:50 -0000
@@ -956,6 +956,9 @@ BOOL WINAPI GetICMProfileA(HDC hDC, LPDW
return TRUE;
}
+/**********************************************************************
+ * GetICMProfileW [GDI32.@]
+ **/
BOOL WINAPI GetICMProfileW(HDC hDC, LPDWORD lpcbName, LPWSTR lpszFilename)
{
DWORD callerLen;
Index: dlls/mshtml/main.c
===================================================================
RCS file: /var/cvs/wine/dlls/mshtml/main.c,v
retrieving revision 1.9
diff -u -p -r1.9 main.c
--- dlls/mshtml/main.c 14 Apr 2005 11:30:50 -0000 1.9
+++ dlls/mshtml/main.c 20 Apr 2005 10:08:05 -0000
@@ -249,7 +249,11 @@ HRESULT WINAPI MSHTML_DllCanUnloadNow(vo
return hres;
}
-/* appears to have the same prototype as WinMain */
+/***********************************************************************
+ * RunHTMLApplication (MSHTML.@)
+ *
+ * Appears to have the same prototype as WinMain.
+ */
INT WINAPI RunHTMLApplication( HINSTANCE hinst, HINSTANCE hPrevInst,
LPCSTR szCmdLine, INT nCmdShow )
{
Index: dlls/msi/action.c
===================================================================
RCS file: /var/cvs/wine/dlls/msi/action.c,v
retrieving revision 1.107
diff -u -p -r1.107 action.c
--- dlls/msi/action.c 11 Apr 2005 16:10:33 -0000 1.107
+++ dlls/msi/action.c 20 Apr 2005 10:19:36 -0000
@@ -6293,6 +6293,10 @@ static UINT ACTION_RegisterFonts(MSIPACK
}
/* Msi functions that seem appropriate here */
+
+/***********************************************************************
+ * MsiDoActionA (MSI.@)
+ */
UINT WINAPI MsiDoActionA( MSIHANDLE hInstall, LPCSTR szAction )
{
LPWSTR szwAction;
@@ -6316,6 +6320,9 @@ UINT WINAPI MsiDoActionA( MSIHANDLE hIns
return rc;
}
+/***********************************************************************
+ * MsiDoActionW (MSI.@)
+ */
UINT WINAPI MsiDoActionW( MSIHANDLE hInstall, LPCWSTR szAction )
{
MSIPACKAGE *package;
@@ -6461,6 +6468,9 @@ UINT WINAPI MsiGetSourcePathW( MSIHANDLE
}
+/***********************************************************************
+ * MsiSetTargetPathA (MSI.@)
+ */
UINT WINAPI MsiSetTargetPathA(MSIHANDLE hInstall, LPCSTR szFolder,
LPCSTR szFolderPath)
{
@@ -6550,6 +6560,9 @@ UINT MSI_SetTargetPathW(MSIPACKAGE *pack
return ERROR_SUCCESS;
}
+/***********************************************************************
+ * MsiSetTargetPathW (MSI.@)
+ */
UINT WINAPI MsiSetTargetPathW(MSIHANDLE hInstall, LPCWSTR szFolder,
LPCWSTR szFolderPath)
{
@@ -6604,7 +6617,9 @@ BOOL WINAPI MsiGetMode(MSIHANDLE hInstal
return TRUE;
}
-/*
+/***********************************************************************
+ * MsiSetFeatureStateA (MSI.@)
+ *
* According to the docs, when this is called it immediately recalculates
* all the component states as well
*/
@@ -6626,6 +6641,9 @@ UINT WINAPI MsiSetFeatureStateA(MSIHANDL
return rc;
}
+/***********************************************************************
+ * MsiSetFeatureStateW (MSI.@)
+ */
UINT WINAPI MsiSetFeatureStateW(MSIHANDLE hInstall, LPCWSTR szFeature,
INSTALLSTATE iState)
{
@@ -6706,6 +6724,9 @@ piAction);
return ret;
}
+/***********************************************************************
+ * MsiGetComponentStateA (MSI.@)
+ */
UINT WINAPI MsiGetComponentStateA(MSIHANDLE hInstall, LPSTR szComponent,
INSTALLSTATE *piInstalled, INSTALLSTATE *piAction)
{
@@ -6745,6 +6766,9 @@ piAction);
return ERROR_SUCCESS;
}
+/***********************************************************************
+ * MsiGetComponentStateW (MSI.@)
+ */
UINT WINAPI MsiGetComponentStateW(MSIHANDLE hInstall, LPWSTR szComponent,
INSTALLSTATE *piInstalled, INSTALLSTATE *piAction)
{
Index: dlls/msi/msi.c
===================================================================
RCS file: /var/cvs/wine/dlls/msi/msi.c,v
retrieving revision 1.71
diff -u -p -r1.71 msi.c
--- dlls/msi/msi.c 29 Mar 2005 11:28:57 -0000 1.71
+++ dlls/msi/msi.c 20 Apr 2005 11:07:33 -0000
@@ -967,6 +967,9 @@ end:
return rrc;
}
+/******************************************************************
+ * MsiQueryFeatureStateA [MSI.@]
+ */
INSTALLSTATE WINAPI MsiQueryFeatureStateA(LPCSTR szProduct, LPCSTR szFeature)
{
INSTALLSTATE rc;
@@ -998,6 +1001,9 @@ INSTALLSTATE WINAPI MsiQueryFeatureState
return rc;
}
+/******************************************************************
+ * MsiQueryFeatureStateW [MSI.@]
+ */
INSTALLSTATE WINAPI MsiQueryFeatureStateW(LPCWSTR szProduct, LPCWSTR szFeature)
{
FIXME("%s %s\n", debugstr_w(szProduct), debugstr_w(szFeature));
@@ -1007,6 +1013,9 @@ INSTALLSTATE WINAPI MsiQueryFeatureState
return INSTALLSTATE_LOCAL;
}
+/******************************************************************
+ * MsiGetFileVersionA [MSI.@]
+ */
UINT WINAPI MsiGetFileVersionA(LPCSTR szFilePath, LPSTR lpVersionBuf,
DWORD* pcchVersionBuf, LPSTR lpLangBuf, DWORD* pcchLangBuf)
{
@@ -1052,6 +1061,9 @@ end:
return ret;
}
+/******************************************************************
+ * MsiGetFileVersionW [MSI.@]
+ */
UINT WINAPI MsiGetFileVersionW(LPCWSTR szFilePath, LPWSTR lpVersionBuf,
DWORD* pcchVersionBuf, LPWSTR lpLangBuf, DWORD* pcchLangBuf)
{
@@ -1192,7 +1204,7 @@ static IClassFactoryVtbl MsiCF_Vtbl =
static IClassFactoryImpl Msi_CF = { &MsiCF_Vtbl };
/******************************************************************
- * DllGetClassObject [MSI.@]
+ * DllGetClassObject [MSI.@]
*/
HRESULT WINAPI MSI_DllGetClassObject(REFCLSID rclsid, REFIID riid, LPVOID *ppv)
{
@@ -1211,7 +1223,7 @@ HRESULT WINAPI MSI_DllGetClassObject(REF
}
/******************************************************************
- * DllGetVersion [MSI.@]
+ * DllGetVersion [MSI.@]
*/
HRESULT WINAPI MSI_DllGetVersion(DLLVERSIONINFO *pdvi)
{
@@ -1229,7 +1241,7 @@ HRESULT WINAPI MSI_DllGetVersion(DLLVERS
}
/******************************************************************
- * DllCanUnloadNow [MSI.@]
+ * DllCanUnloadNow [MSI.@]
*/
BOOL WINAPI MSI_DllCanUnloadNow(void)
{
@@ -1269,6 +1281,9 @@ INSTALLSTATE WINAPI MsiUseFeatureExW(LPC
return INSTALLSTATE_LOCAL;
}
+/***********************************************************************
+ * MsiUseFeatureExA [MSI.@]
+ */
INSTALLSTATE WINAPI MsiUseFeatureExA(LPCSTR szProduct, LPCSTR szFeature,
DWORD dwInstallMode, DWORD dwReserved)
{
Index: dlls/ole32/ole2.c
===================================================================
RCS file: /var/cvs/wine/dlls/ole32/ole2.c,v
retrieving revision 1.63
diff -u -p -r1.63 ole2.c
--- dlls/ole32/ole2.c 13 Apr 2005 11:13:55 -0000 1.63
+++ dlls/ole32/ole2.c 20 Apr 2005 10:53:47 -0000
@@ -2292,13 +2292,13 @@ HRESULT WINAPI OleCreate(
/******************************************************************************
* OleSetAutoConvert [OLE32.@]
*/
-/* FIXME: convert to Unicode */
HRESULT WINAPI OleSetAutoConvert(REFCLSID clsidOld, REFCLSID clsidNew)
{
HKEY hkey = 0;
char buf[200], szClsidNew[200];
HRESULT res = S_OK;
+ /* FIXME: convert to Unicode */
TRACE("(%s,%s)\n", debugstr_guid(clsidOld), debugstr_guid(clsidNew));
sprintf(buf,"CLSID\\");WINE_StringFromCLSID(clsidOld,&buf[6]);
WINE_StringFromCLSID(clsidNew, szClsidNew);
Index: dlls/rpcrt4/rpcrt4_main.c
===================================================================
RCS file: /var/cvs/wine/dlls/rpcrt4/rpcrt4_main.c,v
retrieving revision 1.55
diff -u -p -r1.55 rpcrt4_main.c
--- dlls/rpcrt4/rpcrt4_main.c 24 Mar 2005 21:01:37 -0000 1.55
+++ dlls/rpcrt4/rpcrt4_main.c 20 Apr 2005 10:33:05 -0000
@@ -749,7 +749,10 @@ BOOL RPCRT4_RPCSSOnDemandCall(PRPCSS_NP_
return TRUE;
}
-/* DceErrorInqText
+#define MAX_RPC_ERROR_TEXT 256
+
+/******************************************************************************
+ * DceErrorInqTextW (rpcrt4.@)
*
* Notes
* 1. On passing a NULL pointer the code does bomb out.
@@ -760,9 +763,6 @@ BOOL RPCRT4_RPCSSOnDemandCall(PRPCSS_NP_
* 4. The MSDN documentation currently declares that the second argument is
* unsigned char *, even for the W version. I don't believe it.
*/
-
-#define MAX_RPC_ERROR_TEXT 256
-
RPC_STATUS RPC_ENTRY DceErrorInqTextW (RPC_STATUS e, unsigned short *buffer)
{
DWORD count;
@@ -783,6 +783,9 @@ RPC_STATUS RPC_ENTRY DceErrorInqTextW (R
return RPC_S_OK;
}
+/******************************************************************************
+ * DceErrorInqTextA (rpcrt4.@)
+ */
RPC_STATUS RPC_ENTRY DceErrorInqTextA (RPC_STATUS e, unsigned char *buffer)
{
RPC_STATUS status;
Index: dlls/user/misc.c
===================================================================
RCS file: /var/cvs/wine/dlls/user/misc.c,v
retrieving revision 1.21
diff -u -p -r1.21 misc.c
--- dlls/user/misc.c 20 Jan 2005 19:57:58 -0000 1.21
+++ dlls/user/misc.c 20 Apr 2005 11:00:04 -0000
@@ -58,7 +58,9 @@ static BOOL CALLBACK EnumDesktopProcWtoA
}
/**********************************************************************
- * SetLastErrorEx [USER32.@] Sets the last-error code.
+ * SetLastErrorEx [USER32.@]
+ *
+ * Sets the last-error code.
*
* RETURNS
* None.
@@ -82,12 +84,18 @@ void WINAPI SetLastErrorEx(
SetLastError( error );
}
+/******************************************************************************
+ * GetAltTabInfoA [USER32.@]
+ */
BOOL WINAPI GetAltTabInfoA(HWND hwnd, int iItem, PALTTABINFO pati, LPSTR pszItemText, UINT cchItemText)
{
FIXME("(%p, 0x%08x, %p, %p, 0x%08x)\n", hwnd, iItem, pati, pszItemText, cchItemText);
return FALSE;
}
+/******************************************************************************
+ * GetAltTabInfoW [USER32.@]
+ */
BOOL WINAPI GetAltTabInfoW(HWND hwnd, int iItem, PALTTABINFO pati, LPWSTR pszItemText, UINT cchItemText)
{
FIXME("(%p, 0x%08x, %p, %p, 0x%08x)\n", hwnd, iItem, pati, pszItemText, cchItemText);
@@ -95,7 +103,9 @@ BOOL WINAPI GetAltTabInfoW(HWND hwnd, in
}
/******************************************************************************
- * GetProcessWindowStation [USER32.@] Returns handle of window station
+ * GetProcessWindowStation [USER32.@]
+ *
+ * Returns handle of window station
*
* NOTES
* Docs say the return value is HWINSTA
@@ -112,7 +122,9 @@ HWINSTA WINAPI GetProcessWindowStation(v
/******************************************************************************
- * GetThreadDesktop [USER32.@] Returns handle to desktop
+ * GetThreadDesktop [USER32.@]
+ *
+ * Returns handle to desktop
*
* PARAMS
* dwThreadId [I] Thread identifier
Index: dlls/wininet/ftp.c
===================================================================
RCS file: /var/cvs/wine/dlls/wininet/ftp.c,v
retrieving revision 1.53
diff -u -p -r1.53 ftp.c
--- dlls/wininet/ftp.c 28 Mar 2005 14:58:52 -0000 1.53
+++ dlls/wininet/ftp.c 20 Apr 2005 11:02:48 -0000
@@ -1233,6 +1233,9 @@ lend:
return bSuccess;
}
+/***********************************************************************
+ * FtpGetFileSize (WININET.@)
+ */
DWORD WINAPI FtpGetFileSize( HINTERNET hFile, LPDWORD lpdwFileSizeHigh )
{
FIXME("(%p, %p)\n", hFile, lpdwFileSizeHigh);
@@ -1611,6 +1614,9 @@ lend:
return bSuccess;
}
+/***********************************************************************
+ * FtpCommandA (WININET.@)
+ */
BOOL WINAPI FtpCommandA( HINTERNET hConnect, BOOL fExpectResponse, DWORD dwFlags,
LPCSTR lpszCommand, DWORD_PTR dwContext, HINTERNET* phFtpCommand )
{
@@ -1620,6 +1626,9 @@ BOOL WINAPI FtpCommandA( HINTERNET hConn
return TRUE;
}
+/***********************************************************************
+ * FtpCommandW (WININET.@)
+ */
BOOL WINAPI FtpCommandW( HINTERNET hConnect, BOOL fExpectResponse, DWORD dwFlags,
LPCWSTR lpszCommand, DWORD_PTR dwContext, HINTERNET* phFtpCommand )
{
Index: dlls/x11drv/xrender.c
===================================================================
RCS file: /var/cvs/wine/dlls/x11drv/xrender.c,v
retrieving revision 1.62
diff -u -p -r1.62 xrender.c
--- dlls/x11drv/xrender.c 12 Apr 2005 11:59:48 -0000 1.62
+++ dlls/x11drv/xrender.c 20 Apr 2005 11:03:28 -0000
@@ -1613,6 +1613,9 @@ done:
return retv;
}
+/******************************************************************************
+ * AlphaBlend (x11drv.@)
+ */
BOOL X11DRV_AlphaBlend(X11DRV_PDEVICE *devDst, INT xDst, INT yDst, INT widthDst, INT heightDst,
X11DRV_PDEVICE *devSrc, INT xSrc, INT ySrc, INT widthSrc, INT heightSrc,
BLENDFUNCTION blendfn)
@@ -1785,6 +1788,9 @@ void X11DRV_XRender_UpdateDrawable(X11DR
return;
}
+/******************************************************************************
+ * AlphaBlend (x11drv.@)
+ */
BOOL X11DRV_AlphaBlend(X11DRV_PDEVICE *devDst, INT xDst, INT yDst, INT widthDst, INT heightDst,
X11DRV_PDEVICE *devSrc, INT xSrc, INT ySrc, INT widthSrc, INT heightSrc,
BLENDFUNCTION blendfn)
More information about the wine-patches
mailing list