Documentation tweaks to make winapi_check happy

Francois Gouget fgouget at free.fr
Wed Nov 23 08:42:29 CST 2005


Changelog:

  * dlls/ntdll/resource.c
    dlls/usp10/usp10.c
    dlls/wininet/internet.c

    Francois Gouget <fgouget at free.fr>
    Documentation tweaks to make winapi_check happy.
    Also specify the documented spec file entry.

-- 
Francois Gouget         fgouget at free.fr        http://fgouget.free.fr/
         It really galls me that most of the computer power in the world
                           is wasted on screen savers.
                      Chris Caldwell from the GIMPS project
                        http://www.mersenne.org/prime.htm
-------------- next part --------------
Index: dlls/ntdll/resource.c
===================================================================
RCS file: /var/cvs/wine/dlls/ntdll/resource.c,v
retrieving revision 1.18
diff -u -p -r1.18 resource.c
--- dlls/ntdll/resource.c	15 Nov 2005 12:05:45 -0000	1.18
+++ dlls/ntdll/resource.c	17 Nov 2005 09:38:05 -0000
@@ -360,9 +360,12 @@ static inline NTSTATUS access_resource( 
 
 /**********************************************************************
  *	LdrAccessResource  (NTDLL.@)
+ *
+ * NOTE
+ * On x86, Shrinker, an executable compressor, depends on the
+ * "call access_resource" instruction being there.
  */
 #ifdef __i386__
-/* Shrinker depends on the "call access_resource" instruction being there */
 __ASM_GLOBAL_FUNC( LdrAccessResource,
     "pushl %ebp\n"
     "movl %esp, %ebp\n"
Index: dlls/usp10/usp10.c
===================================================================
RCS file: /var/cvs/wine/dlls/usp10/usp10.c,v
retrieving revision 1.4
diff -u -p -r1.4 usp10.c
--- dlls/usp10/usp10.c	15 Nov 2005 12:02:16 -0000	1.4
+++ dlls/usp10/usp10.c	17 Nov 2005 09:36:23 -0000
@@ -50,12 +50,20 @@ BOOL WINAPI DllMain(HINSTANCE hInstDLL, 
     return TRUE;
 }
 
+/***********************************************************************
+ *      ScriptGetProperties (USP10.@)
+ *
+ */
 HRESULT WINAPI ScriptGetProperties(const SCRIPT_PROPERTIES ***ppSp, int *piNumScripts)
 {
     FIXME("%p,%p\n",ppSp,piNumScripts);
     return E_NOTIMPL;
 }
 
+/***********************************************************************
+ *      ScriptGetFontProperties (USP10.@)
+ *
+ */
 HRESULT WINAPI ScriptGetFontProperties(HDC hdc, SCRIPT_CACHE *psc, SCRIPT_FONTPROPERTIES *sfp)
 {
     FIXME("%p,%p,%p\n", hdc, psc, sfp);
@@ -71,12 +79,20 @@ HRESULT WINAPI ScriptGetFontProperties(H
     return 0;
 }
 
+/***********************************************************************
+ *      ScriptRecordDigitSubstitution (USP10.@)
+ *
+ */
 HRESULT WINAPI ScriptRecordDigitSubstitution(LCID Locale,SCRIPT_DIGITSUBSTITUTE *psds)
 {
     FIXME("%ld,%p\n",Locale,psds);
     return E_NOTIMPL;
 }
 
+/***********************************************************************
+ *      ScriptApplyDigitSubstitution (USP10.@)
+ *
+ */
 HRESULT WINAPI ScriptApplyDigitSubstitution(const SCRIPT_DIGITSUBSTITUTE* psds, 
                                             SCRIPT_CONTROL* psc, SCRIPT_STATE* pss)
 {
@@ -84,6 +100,10 @@ HRESULT WINAPI ScriptApplyDigitSubstitut
     return E_NOTIMPL;
 }
 
+/***********************************************************************
+ *      ScriptItemize (USP10.@)
+ *
+ */
 HRESULT WINAPI ScriptItemize(const WCHAR *pwcInChars, int cInChars, int cMaxItems, 
                              const SCRIPT_CONTROL *psControl, const SCRIPT_STATE *psState, 
                              SCRIPT_ITEM *pItems, int *pcItems)
@@ -93,6 +113,10 @@ HRESULT WINAPI ScriptItemize(const WCHAR
     return E_INVALIDARG;
 }
 
+/***********************************************************************
+ *      ScriptStringAnalyse (USP10.@)
+ *
+ */
 HRESULT WINAPI ScriptStringAnalyse(HDC hdc, 
 				   const void *pString, 
 				   int cString, 
@@ -120,11 +144,19 @@ HRESULT WINAPI ScriptStringAnalyse(HDC h
   return E_NOTIMPL;
 }
 
+/***********************************************************************
+ *      ScriptStringFree (USP10.@)
+ *
+ */
 HRESULT WINAPI ScriptStringFree(SCRIPT_STRING_ANALYSIS *pssa) {
   FIXME("(%p): stub\n",pssa);
   return S_OK;
 }
 
+/***********************************************************************
+ *      ScriptIsComplex (USP10.@)
+ *
+ */
 HRESULT WINAPI ScriptIsComplex(const WCHAR* pwcInChars, int cInChars, DWORD dwFlags) {
   FIXME("(%s,%d,0x%lx): stub\n",  debugstr_w(pwcInChars), cInChars, dwFlags);
    return E_NOTIMPL;
Index: dlls/wininet/internet.c
===================================================================
RCS file: /var/cvs/wine/dlls/wininet/internet.c,v
retrieving revision 1.144
diff -u -p -r1.144 internet.c
--- dlls/wininet/internet.c	22 Nov 2005 11:59:07 -0000	1.144
+++ dlls/wininet/internet.c	23 Nov 2005 05:46:16 -0000
@@ -3307,7 +3307,7 @@ static VOID INTERNET_ExecuteWork(void)
 
 
 /***********************************************************************
- *          INTERNET_GetResponseBuffer
+ *          INTERNET_GetResponseBuffer  (internal)
  *
  * RETURNS
  *
@@ -3436,7 +3436,7 @@ BOOL WINAPI InternetQueryDataAvailable( 
 
 
 /***********************************************************************
- *
+ *      InternetLockRequestFile (WININET.@)
  */
 BOOL WINAPI InternetLockRequestFile( HINTERNET hInternet, HANDLE
 *lphLockReqHandle)
@@ -3453,7 +3453,7 @@ BOOL WINAPI InternetUnlockRequestFile( H
 
 
 /***********************************************************************
- *           InternetAutodial
+ *      InternetAutodial (WININET.@)
  *
  * On windows this function is supposed to dial the default internet
  * connection. We don't want to have Wine dial out to the internet so
@@ -3473,7 +3473,7 @@ BOOL WINAPI InternetAutodial(DWORD dwFla
 }
 
 /***********************************************************************
- *           InternetAutodialHangup
+ *      InternetAutodialHangup (WININET.@)
  *
  * Hangs up a connection made with InternetAutodial
  *
@@ -3493,8 +3493,7 @@ BOOL WINAPI InternetAutodialHangup(DWORD
 }
 
 /***********************************************************************
- *
- *         InternetCombineUrlA
+ *      InternetCombineUrlA (WININET.@)
  *
  * Combine a base URL with a relative URL
  *
@@ -3520,8 +3519,7 @@ BOOL WINAPI InternetCombineUrlA(LPCSTR l
 }
 
 /***********************************************************************
- *
- *         InternetCombineUrlW
+ *      InternetCombineUrlW (WININET.@)
  *
  * Combine a base URL with a relative URL
  *
@@ -3681,8 +3679,7 @@ static void convert_urlcomp_atow(LPURL_C
 }
 
 /***********************************************************************
- *
- *         InternetCreateUrlA
+ *      InternetCreateUrlA (WININET.@)
  *
  * RETURNS
  *   TRUE on success
@@ -3732,8 +3729,7 @@ BOOL WINAPI InternetCreateUrlA(LPURL_COM
 }
 
 /***********************************************************************
- *
- *         InternetCreateUrlW
+ *      InternetCreateUrlW (WININET.@)
  *
  * RETURNS
  *   TRUE on success
@@ -3818,12 +3814,20 @@ BOOL WINAPI InternetCreateUrlW(LPURL_COM
     return TRUE;
 }
 
+/***********************************************************************
+ *      InternetConfirmZoneCrossingA (WININET.@)
+ *
+ */
 DWORD WINAPI InternetConfirmZoneCrossingA( HWND hWnd, LPSTR szUrlPrev, LPSTR szUrlNew, BOOL bPost )
 {
     FIXME("(%p, %s, %s, %x) stub\n", hWnd, debugstr_a(szUrlPrev), debugstr_a(szUrlNew), bPost);
     return ERROR_SUCCESS;
 }
 
+/***********************************************************************
+ *      InternetConfirmZoneCrossingW (WININET.@)
+ *
+ */
 DWORD WINAPI InternetConfirmZoneCrossingW( HWND hWnd, LPWSTR szUrlPrev, LPWSTR szUrlNew, BOOL bPost )
 {
     FIXME("(%p, %s, %s, %x) stub\n", hWnd, debugstr_w(szUrlPrev), debugstr_w(szUrlNew), bPost);


More information about the wine-patches mailing list