Add some API documentation stubs to make winapi_check happy.

2008-07-26 19:20:33 +02:00 · 2008-07-26 19:20:33 +02:00 · eb16f43bdf
parent e59ef5658b
commit eb16f43bdf
9 changed files with 91 additions and 12 deletions
--- a/dlls/d3dx9_36/font.c
+++ b/dlls/d3dx9_36/font.c
@ -231,6 +231,9 @@ HRESULT WINAPI D3DXCreateFontW(LPDIRECT3DDEVICE9 device, INT height, UINT width,
    return D3DXCreateFontIndirectW(device, &desc, font);
 }

+/***********************************************************************
+ *           D3DXCreateFontIndirectA    (D3DX9_36.@)
+ */
 HRESULT WINAPI D3DXCreateFontIndirectA(LPDIRECT3DDEVICE9 device, CONST D3DXFONT_DESCA *desc, LPD3DXFONT *font)
 {
    D3DXFONT_DESCW widedesc;
@ -246,6 +249,9 @@ HRESULT WINAPI D3DXCreateFontIndirectA(LPDIRECT3DDEVICE9 device, CONST D3DXFONT_
    return D3DXCreateFontIndirectW(device, &widedesc, font);
 }

+/***********************************************************************
+ *           D3DXCreateFontIndirectW    (D3DX9_36.@)
+ */
 HRESULT WINAPI D3DXCreateFontIndirectW(LPDIRECT3DDEVICE9 device, CONST D3DXFONT_DESCW *desc, LPD3DXFONT *font)
 {
    ID3DXFontImpl *object;
--- a/dlls/gdi32/font.c
+++ b/dlls/gdi32/font.c
@ -3254,11 +3254,6 @@ BOOL WINAPI FontIsLinked(HDC hdc)
    return ret;
 }

-/*************************************************************
- *           GdiRealizationInfo    (GDI32.@)
- *
- * Returns a structure that contains some font information.
- */
 typedef struct
 {
    DWORD flags;       /* 1 for bitmap fonts, 3 for scalable fonts */
@ -3267,6 +3262,11 @@ typedef struct
                          in which the face was first rendered. */
 } realization_info_t;

+/*************************************************************
+ *           GdiRealizationInfo    (GDI32.@)
+ *
+ * Returns a structure that contains some font information.
+ */
 BOOL WINAPI GdiRealizationInfo(HDC hdc, realization_info_t *info)
 {
    UINT otm_size;
--- a/dlls/gdiplus/font.c
+++ b/dlls/gdiplus/font.c
@ -157,6 +157,9 @@ GpStatus WINGDIPAPI GdipCreateFont(GDIPCONST GpFontFamily *fontFamily,
    return Ok;
 }

+/*******************************************************************************
+ * GdipCreateFontFromLogfontW [GDIPLUS.@]
+ */
 GpStatus WINGDIPAPI GdipCreateFontFromLogfontW(HDC hdc,
    GDIPCONST LOGFONTW *logfont, GpFont **font)
 {
@ -192,6 +195,9 @@ GpStatus WINGDIPAPI GdipCreateFontFromLogfontW(HDC hdc,
    return Ok;
 }

+/*******************************************************************************
+ * GdipCreateFontFromLogfontA [GDIPLUS.@]
+ */
 GpStatus WINGDIPAPI GdipCreateFontFromLogfontA(HDC hdc,
    GDIPCONST LOGFONTA *lfa, GpFont **font)
 {
@ -210,6 +216,9 @@ GpStatus WINGDIPAPI GdipCreateFontFromLogfontA(HDC hdc,
    return Ok;
 }

+/*******************************************************************************
+ * GdipDeleteFont [GDIPLUS.@]
+ */
 GpStatus WINGDIPAPI GdipDeleteFont(GpFont* font)
 {
    if(!font)
@ -220,6 +229,9 @@ GpStatus WINGDIPAPI GdipDeleteFont(GpFont* font)
    return Ok;
 }

+/*******************************************************************************
+ * GdipCreateFontFromDC [GDIPLUS.@]
+ */
 GpStatus WINGDIPAPI GdipCreateFontFromDC(HDC hdc, GpFont **font)
 {
    HFONT hfont;
@ -283,10 +295,13 @@ GpStatus WINGDIPAPI GdipGetFontUnit(GpFont *font, Unit *unit)
    return Ok;
 }

-/* FIXME: use graphics */
+/*******************************************************************************
+ * GdipGetLogFontW [GDIPLUS.@]
+ */
 GpStatus WINGDIPAPI GdipGetLogFontW(GpFont *font, GpGraphics *graphics,
    LOGFONTW *lfw)
 {
+    /* FIXME: use graphics */
    if(!font || !graphics || !lfw)
        return InvalidParameter;

@ -295,6 +310,9 @@ GpStatus WINGDIPAPI GdipGetLogFontW(GpFont *font, GpGraphics *graphics,
    return Ok;
 }

+/*******************************************************************************
+ * GdipCloneFont [GDIPLUS.@]
+ */
 GpStatus WINGDIPAPI GdipCloneFont(GpFont *font, GpFont **cloneFont)
 {
    if(!font || !cloneFont)
@ -645,6 +663,9 @@ GpStatus WINGDIPAPI GdipGetGenericFontFamilySansSerif(GpFontFamily **nativeFamil
    return GdipCreateFontFamilyFromName(MSSansSerif, NULL, nativeFamily);
 }

+/*****************************************************************************
+ * GdipGetGenericFontFamilySansSerif [GDIPLUS.@]
+ */
 GpStatus WINGDIPAPI GdipNewPrivateFontCollection(GpFontCollection** fontCollection)
 {
    FIXME("stub %p\n", fontCollection);
@ -655,6 +676,9 @@ GpStatus WINGDIPAPI GdipNewPrivateFontCollection(GpFontCollection** fontCollecti
    return NotImplemented;
 }

+/*****************************************************************************
+ * GdipDeletePrivateFontCollection [GDIPLUS.@]
+ */
 GpStatus WINGDIPAPI GdipDeletePrivateFontCollection(GpFontCollection **fontCollection)
 {
    FIXME("stub %p\n", fontCollection);
@ -665,6 +689,9 @@ GpStatus WINGDIPAPI GdipDeletePrivateFontCollection(GpFontCollection **fontColle
    return NotImplemented;
 }

+/*****************************************************************************
+ * GdipPrivateAddFontFile [GDIPLUS.@]
+ */
 GpStatus WINGDIPAPI GdipPrivateAddFontFile(GpFontCollection* fontCollection,
        GDIPCONST WCHAR* filename)
 {
@ -676,6 +703,9 @@ GpStatus WINGDIPAPI GdipPrivateAddFontFile(GpFontCollection* fontCollection,
    return NotImplemented;
 }

+/*****************************************************************************
+ * GdipGetFontCollectionFamilyCount [GDIPLUS.@]
+ */
 GpStatus WINGDIPAPI GdipGetFontCollectionFamilyCount(
        GpFontCollection* fontCollection, INT* numFound)
 {
@ -687,6 +717,9 @@ GpStatus WINGDIPAPI GdipGetFontCollectionFamilyCount(
    return NotImplemented;
 }

+/*****************************************************************************
+ * GdipGetFontCollectionFamilyList [GDIPLUS.@]
+ */
 GpStatus WINGDIPAPI GdipGetFontCollectionFamilyList(
        GpFontCollection* fontCollection, INT numSought,
        GpFontFamily* gpfamilies[], INT* numFound)
--- a/dlls/gdiplus/image.c
+++ b/dlls/gdiplus/image.c
@ -1003,6 +1003,9 @@ static encode_image_func *const encode_image_funcs[NUM_ENCODERS_SUPPORTED] = {
    encode_image_BMP,
 };

+/*****************************************************************************
+ * GdipSaveImageToStream [GDIPLUS.@]
+ */
 GpStatus WINGDIPAPI GdipSaveImageToStream(GpImage *image, IStream* stream,
    GDIPCONST CLSID* clsid, GDIPCONST EncoderParameters* params)
 {
@ -1085,6 +1088,9 @@ GpStatus WINGDIPAPI GdipSaveImageToStream(GpImage *image, IStream* stream,
    return stat;
 }

+/*****************************************************************************
+ * GdipSetImagePalette [GDIPLUS.@]
+ */
 GpStatus WINGDIPAPI GdipSetImagePalette(GpImage *image,
    GDIPCONST ColorPalette *palette)
 {
@ -1131,6 +1137,9 @@ static const ImageCodecInfo codecs[NUM_ENCODERS_SUPPORTED] =
        },
    };

+/*****************************************************************************
+ * GdipGetImageEncodersSize [GDIPLUS.@]
+ */
 GpStatus WINGDIPAPI GdipGetImageEncodersSize(UINT *numEncoders, UINT *size)
 {
    if (!numEncoders || !size)
@ -1142,6 +1151,9 @@ GpStatus WINGDIPAPI GdipGetImageEncodersSize(UINT *numEncoders, UINT *size)
    return Ok;
 }

+/*****************************************************************************
+ * GdipGetImageEncoders [GDIPLUS.@]
+ */
 GpStatus WINGDIPAPI GdipGetImageEncoders(UINT numEncoders, UINT size, ImageCodecInfo *encoders)
 {
    if (!encoders ||
@ -1153,6 +1165,10 @@ GpStatus WINGDIPAPI GdipGetImageEncoders(UINT numEncoders, UINT size, ImageCodec

    return Ok;
 }
+
+/*****************************************************************************
+ * GdipCreateBitmapFromHBITMAP [GDIPLUS.@]
+ */
 GpStatus WINGDIPAPI GdipCreateBitmapFromHBITMAP(HBITMAP hbm, HPALETTE hpal, GpBitmap** bitmap)
 {
    BITMAP bm;
@ -1199,6 +1215,9 @@ GpStatus WINGDIPAPI GdipCreateBitmapFromHBITMAP(HBITMAP hbm, HPALETTE hpal, GpBi
    return retval;
 }

+/*****************************************************************************
+ * GdipSetEffectParameters [GDIPLUS.@]
+ */
 GpStatus WINGDIPAPI GdipSetEffectParameters(CGpEffect *effect,
    const VOID *params, const UINT size)
 {
@ -1210,6 +1229,9 @@ GpStatus WINGDIPAPI GdipSetEffectParameters(CGpEffect *effect,
    return NotImplemented;
 }

+/*****************************************************************************
+ * GdipGetImageFlags [GDIPLUS.@]
+ */
 GpStatus WINGDIPAPI GdipGetImageFlags(GpImage *image, UINT *flags)
 {
    if(!image || !flags)
--- a/dlls/gdiplus/region.c
+++ b/dlls/gdiplus/region.c
@ -142,6 +142,9 @@ static inline void delete_element(region_element* element)
    }
 }

+/*****************************************************************************
+ * GdipCloneRegion [GDIPLUS.@]
+ */
 GpStatus WINGDIPAPI GdipCloneRegion(GpRegion *region, GpRegion **clone)
 {
    FIXME("(%p %p): stub\n", region, clone);
@ -278,6 +281,9 @@ GpStatus WINGDIPAPI GdipGetRegionDataSize(GpRegion *region, UINT *needed)
    return Ok;
 }

+/*****************************************************************************
+ * GdipGetRegionHRgn [GDIPLUS.@]
+ */
 GpStatus WINGDIPAPI GdipGetRegionHRgn(GpRegion *region, GpGraphics *graphics, HRGN *hrgn)
 {
    FIXME("(%p, %p, %p): stub\n", region, graphics, hrgn);
--- a/dlls/inetmib1/main.c
+++ b/dlls/inetmib1/main.c
@ -1169,6 +1169,9 @@ static struct mibImplementation supportedIDs[] = {
 };
 static UINT minSupportedIDLength;

+/*****************************************************************************
+ * SnmpExtensionInit [INETMIB1.@]
+ */
 BOOL WINAPI SnmpExtensionInit(DWORD dwUptimeReference,
    HANDLE *phSubagentTrapEvent, AsnObjectIdentifier *pFirstSupportedRegion)
 {
@ -1228,6 +1231,9 @@ static struct mibImplementation *findSupportedQuery(UINT *ids, UINT idLength,
    return impl;
 }

+/*****************************************************************************
+ * SnmpExtensionQuery [INETMIB1.@]
+ */
 BOOL WINAPI SnmpExtensionQuery(BYTE bPduType, SnmpVarBindList *pVarBindList,
    AsnInteger32 *pErrorStatus, AsnInteger32 *pErrorIndex)
 {
@ -1297,6 +1303,9 @@ BOOL WINAPI SnmpExtensionQuery(BYTE bPduType, SnmpVarBindList *pVarBindList,
    return TRUE;
 }

+/*****************************************************************************
+ * DllMain [INETMIB1.@]
+ */
 BOOL WINAPI DllMain(HINSTANCE hinstDLL, DWORD fdwReason, LPVOID lpvReserved)
 {
    TRACE("(0x%p, %d, %p)\n", hinstDLL, fdwReason, lpvReserved);
--- a/dlls/rpcrt4/rpc_epmap.c
+++ b/dlls/rpcrt4/rpc_epmap.c
@ -447,6 +447,9 @@ RPC_STATUS WINAPI RpcEpResolveBinding( RPC_BINDING_HANDLE Binding, RPC_IF_HANDLE
  return EPT_S_NOT_REGISTERED;
 }

+/*****************************************************************************
+ * TowerExplode (RPCRT4.@)
+ */
 RPC_STATUS WINAPI TowerExplode(
    const twr_t *tower, PRPC_SYNTAX_IDENTIFIER object, PRPC_SYNTAX_IDENTIFIER syntax,
    char **protseq, char **endpoint, char **address)
--- a/dlls/shell32/shellpath.c
+++ b/dlls/shell32/shellpath.c
@ -661,9 +661,6 @@ BOOL WINAPI PathQualifyAW(LPCVOID pszPath)
 	return PathQualifyA(pszPath);
 }

-/*************************************************************************
- * PathResolveA [SHELL32.51]
- */
 BOOL WINAPI PathResolveA(
 	LPSTR lpszPath,
 	LPCSTR *alpszPaths,
@ -674,9 +671,6 @@ BOOL WINAPI PathResolveA(
 	return 0;
 }

-/*************************************************************************
- * PathResolveW [SHELL32]
- */
 BOOL WINAPI PathResolveW(
 	LPWSTR lpszPath,
 	LPCWSTR *alpszPaths,
@ -1729,6 +1723,9 @@ cleanup:
    return hr;
 }

+/*************************************************************************
+ * SHGetFolderPathAndSubDirW		[SHELL32.@]
+ */
 HRESULT WINAPI SHGetFolderPathAndSubDirW(
 	HWND hwndOwner,    /* [I] owner window */
 	int nFolder,       /* [I] CSIDL identifying the folder */
--- a/dlls/wininet/urlcache.c
+++ b/dlls/wininet/urlcache.c
@ -3107,6 +3107,9 @@ BOOL WINAPI FindNextUrlCacheEntryA(
    return FALSE;
 }

+/***********************************************************************
+ *           FindNextUrlCacheEntryW (WININET.@)
+ */
 BOOL WINAPI FindNextUrlCacheEntryW(
  HANDLE hEnumHandle,
  LPINTERNET_CACHE_ENTRY_INFOW lpNextCacheEntryInfo,