Improve c2man Documented-Total count.

This commit is contained in:
Markus Amsler 2005-11-05 10:45:02 +00:00 committed by Alexandre Julliard
parent 329f4edefc
commit 79e3a1be70
8 changed files with 60 additions and 9 deletions

View File

@ -661,6 +661,8 @@ INT WINAPI Escape( HDC hdc, INT escape, INT in_count, LPCSTR in_data, LPVOID out
/****************************************************************************** /******************************************************************************
* ExtEscape [GDI32.@] * ExtEscape [GDI32.@]
* *
* Access capabilities of a particular device that are not available through GDI.
*
* PARAMS * PARAMS
* hdc [I] Handle to device context * hdc [I] Handle to device context
* nEscape [I] Escape function * nEscape [I] Escape function

View File

@ -379,6 +379,10 @@ HENHMETAFILE WINAPI GetEnhMetaFileW(
/***************************************************************************** /*****************************************************************************
* GetEnhMetaFileHeader (GDI32.@) * GetEnhMetaFileHeader (GDI32.@)
* *
* Retrieves the record containing the header for the specified
* enhanced-format metafile.
*
* RETURNS
* If buf is NULL, returns the size of buffer required. * If buf is NULL, returns the size of buffer required.
* Otherwise, copy up to bufsize bytes of enhanced metafile header into * Otherwise, copy up to bufsize bytes of enhanced metafile header into
* buf. * buf.
@ -404,6 +408,8 @@ UINT WINAPI GetEnhMetaFileHeader(
/***************************************************************************** /*****************************************************************************
* GetEnhMetaFileDescriptionA (GDI32.@) * GetEnhMetaFileDescriptionA (GDI32.@)
*
* See GetEnhMetaFileDescriptionW.
*/ */
UINT WINAPI GetEnhMetaFileDescriptionA( UINT WINAPI GetEnhMetaFileDescriptionA(
HENHMETAFILE hmf, /* [in] enhanced metafile */ HENHMETAFILE hmf, /* [in] enhanced metafile */
@ -433,6 +439,7 @@ UINT WINAPI GetEnhMetaFileDescriptionA(
* Copies the description string of an enhanced metafile into a buffer * Copies the description string of an enhanced metafile into a buffer
* _buf_. * _buf_.
* *
* RETURNS
* If _buf_ is NULL, returns size of _buf_ required. Otherwise, returns * If _buf_ is NULL, returns size of _buf_ required. Otherwise, returns
* number of characters copied. * number of characters copied.
*/ */
@ -2369,6 +2376,9 @@ static INT CALLBACK EMF_PlayEnhMetaFileCallback(HDC hdc, HANDLETABLE *ht,
* Renders an enhanced metafile into a specified rectangle *lpRect * Renders an enhanced metafile into a specified rectangle *lpRect
* in device context hdc. * in device context hdc.
* *
* RETURNS
* Success: TRUE
* Failure: FALSE
*/ */
BOOL WINAPI PlayEnhMetaFile( BOOL WINAPI PlayEnhMetaFile(
HDC hdc, /* [in] DC to render into */ HDC hdc, /* [in] DC to render into */

View File

@ -1060,6 +1060,8 @@ INT WINAPI GetTextFaceW( HDC hdc, INT count, LPWSTR name )
/*********************************************************************** /***********************************************************************
* GetTextExtentPoint32A (GDI32.@) * GetTextExtentPoint32A (GDI32.@)
*
* See GetTextExtentPoint32W.
*/ */
BOOL WINAPI GetTextExtentPoint32A( HDC hdc, LPCSTR str, INT count, BOOL WINAPI GetTextExtentPoint32A( HDC hdc, LPCSTR str, INT count,
LPSIZE size ) LPSIZE size )
@ -2183,7 +2185,7 @@ BOOL WINAPI TextOutW(HDC hdc, INT x, INT y, LPCWSTR str, INT count)
/*********************************************************************** /***********************************************************************
* PolyTextOutA (GDI32.@) * PolyTextOutA (GDI32.@)
* *
* Draw several Strings * See PolyTextOutW.
*/ */
BOOL WINAPI PolyTextOutA ( HDC hdc, /* [in] Handle to device context */ BOOL WINAPI PolyTextOutA ( HDC hdc, /* [in] Handle to device context */
PPOLYTEXTA pptxt, /* [in] Array of strings */ PPOLYTEXTA pptxt, /* [in] Array of strings */
@ -2201,6 +2203,10 @@ BOOL WINAPI PolyTextOutA ( HDC hdc, /* [in] Handle to device conte
* PolyTextOutW (GDI32.@) * PolyTextOutW (GDI32.@)
* *
* Draw several Strings * Draw several Strings
*
* RETURNS
* TRUE: Success.
* FALSE: Failure.
*/ */
BOOL WINAPI PolyTextOutW ( HDC hdc, /* [in] Handle to device context */ BOOL WINAPI PolyTextOutW ( HDC hdc, /* [in] Handle to device context */
PPOLYTEXTW pptxt, /* [in] Array of strings */ PPOLYTEXTW pptxt, /* [in] Array of strings */
@ -2256,6 +2262,8 @@ BOOL WINAPI GetAspectRatioFilterEx( HDC hdc, LPSIZE pAspectRatio )
/*********************************************************************** /***********************************************************************
* GetCharABCWidthsA (GDI32.@) * GetCharABCWidthsA (GDI32.@)
*
* See GetCharABCWidthsW.
*/ */
BOOL WINAPI GetCharABCWidthsA(HDC hdc, UINT firstChar, UINT lastChar, BOOL WINAPI GetCharABCWidthsA(HDC hdc, UINT firstChar, UINT lastChar,
LPABC abc ) LPABC abc )
@ -2624,6 +2632,8 @@ DWORD WINAPI GetGlyphIndicesW(HDC hdc, LPCWSTR lpstr, INT count,
/************************************************************************* /*************************************************************************
* GetCharacterPlacementA [GDI32.@] * GetCharacterPlacementA [GDI32.@]
* *
* See GetCharacterPlacementW.
*
* NOTES: * NOTES:
* the web browser control of ie4 calls this with dwFlags=0 * the web browser control of ie4 calls this with dwFlags=0
*/ */

View File

@ -483,6 +483,8 @@ HMETAFILE WINAPI CopyMetaFileW( HMETAFILE hSrcMetaFile, LPCWSTR lpFilename )
/****************************************************************** /******************************************************************
* CopyMetaFileA (GDI32.@) * CopyMetaFileA (GDI32.@)
*
* See CopyMetaFileW.
*/ */
HMETAFILE WINAPI CopyMetaFileA( HMETAFILE hSrcMetaFile, LPCSTR lpFilename ) HMETAFILE WINAPI CopyMetaFileA( HMETAFILE hSrcMetaFile, LPCSTR lpFilename )
{ {
@ -618,6 +620,10 @@ BOOL16 WINAPI PlayMetaFile16( HDC16 hdc, HMETAFILE16 hmf )
* PARAMS * PARAMS
* hdc [I] handle of DC to render in * hdc [I] handle of DC to render in
* hmf [I] handle of metafile to render * hmf [I] handle of metafile to render
*
* RETURNS
* Success: TRUE
* Failure: FALSE
*/ */
BOOL WINAPI PlayMetaFile( HDC hdc, HMETAFILE hmf ) BOOL WINAPI PlayMetaFile( HDC hdc, HMETAFILE hmf )
{ {
@ -1323,6 +1329,9 @@ HGLOBAL16 WINAPI GetMetaFileBits16( HMETAFILE16 hmf )
* *
* PARAMS * PARAMS
* hMem [I] handle to a memory region holding a metafile * hMem [I] handle to a memory region holding a metafile
*
* RETURNS
* Handle to a metafile on success, NULL on failure..
*/ */
HMETAFILE16 WINAPI SetMetaFileBits16( HGLOBAL16 hMem ) HMETAFILE16 WINAPI SetMetaFileBits16( HGLOBAL16 hMem )
{ {
@ -1358,6 +1367,10 @@ HMETAFILE16 WINAPI SetMetaFileBitsBetter16( HMETAFILE16 hMeta )
* PARAMS * PARAMS
* size [I] size of metafile, in bytes * size [I] size of metafile, in bytes
* lpData [I] pointer to metafile data * lpData [I] pointer to metafile data
*
* RETURNS
* Success: Handle to metafile.
* Failure: NULL.
*/ */
HMETAFILE WINAPI SetMetaFileBitsEx( UINT size, const BYTE *lpData ) HMETAFILE WINAPI SetMetaFileBitsEx( UINT size, const BYTE *lpData )
{ {
@ -1390,13 +1403,15 @@ HMETAFILE WINAPI SetMetaFileBitsEx( UINT size, const BYTE *lpData )
* Get raw metafile data. * Get raw metafile data.
* *
* Copies the data from metafile _hmf_ into the buffer _buf_. * Copies the data from metafile _hmf_ into the buffer _buf_.
* If _buf_ is zero, returns size of buffer required. Otherwise,
* returns number of bytes copied.
* *
* PARAMS * PARAMS
* hmf [I] metafile * hmf [I] metafile
* nSize [I] size of buf * nSize [I] size of buf
* buf [O] buffer to receive raw metafile data * buf [O] buffer to receive raw metafile data
*
* RETURNS
* If _buf_ is zero, returns size of buffer required. Otherwise,
* returns number of bytes copied.
*/ */
UINT WINAPI GetMetaFileBitsEx( HMETAFILE hmf, UINT nSize, LPVOID buf ) UINT WINAPI GetMetaFileBitsEx( HMETAFILE hmf, UINT nSize, LPVOID buf )
{ {

View File

@ -275,6 +275,8 @@ HDC WINAPI CreateMetaFileW( LPCWSTR filename )
/********************************************************************** /**********************************************************************
* CreateMetaFileA (GDI32.@) * CreateMetaFileA (GDI32.@)
*
* See CreateMetaFileW.
*/ */
HDC WINAPI CreateMetaFileA(LPCSTR filename) HDC WINAPI CreateMetaFileA(LPCSTR filename)
{ {

View File

@ -340,7 +340,9 @@ INT WINAPI ChoosePixelFormat( HDC hdc, const PIXELFORMATDESCRIPTOR* ppfd )
* iPixelFormat [I] Pixel format index * iPixelFormat [I] Pixel format index
* ppfd [I] Pixel format for which a match is sought * ppfd [I] Pixel format for which a match is sought
* *
* RETURNS STD * RETURNS
* Success: TRUE
* Failure: FALSE
*/ */
BOOL WINAPI SetPixelFormat( HDC hdc, INT iPixelFormat, BOOL WINAPI SetPixelFormat( HDC hdc, INT iPixelFormat,
const PIXELFORMATDESCRIPTOR *ppfd) const PIXELFORMATDESCRIPTOR *ppfd)
@ -433,7 +435,9 @@ INT WINAPI DescribePixelFormat( HDC hdc, INT iPixelFormat, UINT nBytes,
* PARAMS * PARAMS
* hdc [I] Device context whose buffers get swapped * hdc [I] Device context whose buffers get swapped
* *
* RETURNS STD * RETURNS
* Success: TRUE
* Failure: FALSE
*/ */
BOOL WINAPI SwapBuffers( HDC hdc ) BOOL WINAPI SwapBuffers( HDC hdc )
{ {
@ -689,7 +693,9 @@ BOOL WINAPI FloodFill( HDC hdc, INT x, INT y, COLORREF color )
* lppt [I] Pointer to endpoints and control points * lppt [I] Pointer to endpoints and control points
* cPoints [I] Count of endpoints and control points * cPoints [I] Count of endpoints and control points
* *
* RETURNS STD * RETURNS
* Success: TRUE
* Failure: FALSE
*/ */
BOOL WINAPI PolyBezier( HDC hdc, const POINT* lppt, DWORD cPoints ) BOOL WINAPI PolyBezier( HDC hdc, const POINT* lppt, DWORD cPoints )
{ {
@ -732,7 +738,9 @@ BOOL WINAPI PolyBezier( HDC hdc, const POINT* lppt, DWORD cPoints )
* lppt [I] Pointer to endpoints and control points * lppt [I] Pointer to endpoints and control points
* cPoints [I] Count of endpoints and control points * cPoints [I] Count of endpoints and control points
* *
* RETURNS STD * RETURNS
* Success: TRUE
* Failure: FALSE
*/ */
BOOL WINAPI PolyBezierTo( HDC hdc, const POINT* lppt, DWORD cPoints ) BOOL WINAPI PolyBezierTo( HDC hdc, const POINT* lppt, DWORD cPoints )
{ {
@ -1134,7 +1142,7 @@ POINT *GDI_Bezier( const POINT *Points, INT count, INT *nPtsOut )
} }
/****************************************************************************** /******************************************************************************
* GradientFill (GDI32.@) * GdiGradientFill (GDI32.@)
* *
* FIXME: we don't support the Alpha channel properly * FIXME: we don't support the Alpha channel properly
*/ */

View File

@ -491,6 +491,8 @@ BOOL WINAPI AnimatePalette(
/*********************************************************************** /***********************************************************************
* SetSystemPaletteUse [GDI32.@] * SetSystemPaletteUse [GDI32.@]
* *
* Specify whether the system palette contains 2 or 20 static colors.
*
* RETURNS * RETURNS
* Success: Previous system palette * Success: Previous system palette
* Failure: SYSPAL_ERROR * Failure: SYSPAL_ERROR

View File

@ -201,7 +201,9 @@ BOOL WINAPI EndPath(HDC hdc)
* PARAMS * PARAMS
* hdc [I] Handle to device context * hdc [I] Handle to device context
* *
* RETURNS STD * RETURNS
* Success: TRUE
* Failure: FALSE
*/ */
BOOL WINAPI AbortPath( HDC hdc ) BOOL WINAPI AbortPath( HDC hdc )
{ {