gdi32: improve c2man generation
Markus Amsler
markus.amsler at oribi.org
Fri Nov 4 08:27:30 CST 2005
This patch improves the c2man Documented-Total count of gdi32 from
71(19%) to 92(25%).
Changelog:
Markus Amsler <markus.amsler at oribi.org>
Improve c2man Documented-Total count.
-------------- next part --------------
Index: dlls/gdi/driver.c
===================================================================
RCS file: /home/wine/wine/dlls/gdi/driver.c,v
retrieving revision 1.42
diff -u -r1.42 driver.c
--- dlls/gdi/driver.c 31 Oct 2005 15:43:10 -0000 1.42
+++ dlls/gdi/driver.c 4 Nov 2005 14:24:58 -0000
@@ -661,6 +661,8 @@
/******************************************************************************
* ExtEscape [GDI32.@]
*
+ * Access capabilities of a particular device that are not available through GDI.
+ *
* PARAMS
* hdc [I] Handle to device context
* nEscape [I] Escape function
Index: dlls/gdi/enhmetafile.c
===================================================================
RCS file: /home/wine/wine/dlls/gdi/enhmetafile.c,v
retrieving revision 1.16
diff -u -r1.16 enhmetafile.c
--- dlls/gdi/enhmetafile.c 31 Oct 2005 21:04:18 -0000 1.16
+++ dlls/gdi/enhmetafile.c 4 Nov 2005 14:24:58 -0000
@@ -379,6 +379,10 @@
/*****************************************************************************
* 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.
* Otherwise, copy up to bufsize bytes of enhanced metafile header into
* buf.
@@ -404,6 +408,8 @@
/*****************************************************************************
* GetEnhMetaFileDescriptionA (GDI32.@)
+ *
+ * See GetEnhMetaFileDescriptionW.
*/
UINT WINAPI GetEnhMetaFileDescriptionA(
HENHMETAFILE hmf, /* [in] enhanced metafile */
@@ -433,6 +439,7 @@
* Copies the description string of an enhanced metafile into a buffer
* _buf_.
*
+ * RETURNS
* If _buf_ is NULL, returns size of _buf_ required. Otherwise, returns
* number of characters copied.
*/
@@ -2369,6 +2376,9 @@
* Renders an enhanced metafile into a specified rectangle *lpRect
* in device context hdc.
*
+ * RETURNS
+ * Success: TRUE
+ * Failure: FALSE
*/
BOOL WINAPI PlayEnhMetaFile(
HDC hdc, /* [in] DC to render into */
Index: dlls/gdi/font.c
===================================================================
RCS file: /home/wine/wine/dlls/gdi/font.c,v
retrieving revision 1.22
diff -u -r1.22 font.c
--- dlls/gdi/font.c 27 Oct 2005 18:28:43 -0000 1.22
+++ dlls/gdi/font.c 4 Nov 2005 14:24:59 -0000
@@ -1060,6 +1060,8 @@
/***********************************************************************
* GetTextExtentPoint32A (GDI32.@)
+ *
+ * See GetTextExtentPoint32W.
*/
BOOL WINAPI GetTextExtentPoint32A( HDC hdc, LPCSTR str, INT count,
LPSIZE size )
@@ -2183,7 +2185,7 @@
/***********************************************************************
* PolyTextOutA (GDI32.@)
*
- * Draw several Strings
+ * See PolyTextOutW.
*/
BOOL WINAPI PolyTextOutA ( HDC hdc, /* [in] Handle to device context */
PPOLYTEXTA pptxt, /* [in] Array of strings */
@@ -2201,6 +2203,10 @@
* PolyTextOutW (GDI32.@)
*
* Draw several Strings
+ *
+ * RETURNS
+ * TRUE: Success.
+ * FALSE: Failure.
*/
BOOL WINAPI PolyTextOutW ( HDC hdc, /* [in] Handle to device context */
PPOLYTEXTW pptxt, /* [in] Array of strings */
@@ -2256,6 +2262,8 @@
/***********************************************************************
* GetCharABCWidthsA (GDI32.@)
+ *
+ * See GetCharABCWidthsW.
*/
BOOL WINAPI GetCharABCWidthsA(HDC hdc, UINT firstChar, UINT lastChar,
LPABC abc )
@@ -2624,6 +2632,8 @@
/*************************************************************************
* GetCharacterPlacementA [GDI32.@]
*
+ * See GetCharacterPlacementW.
+ *
* NOTES:
* the web browser control of ie4 calls this with dwFlags=0
*/
Index: dlls/gdi/metafile.c
===================================================================
RCS file: /home/wine/wine/dlls/gdi/metafile.c,v
retrieving revision 1.9
diff -u -r1.9 metafile.c
--- dlls/gdi/metafile.c 19 Oct 2005 18:28:14 -0000 1.9
+++ dlls/gdi/metafile.c 4 Nov 2005 14:24:59 -0000
@@ -483,6 +483,8 @@
/******************************************************************
* CopyMetaFileA (GDI32.@)
+ *
+ * See CopyMetaFileW.
*/
HMETAFILE WINAPI CopyMetaFileA( HMETAFILE hSrcMetaFile, LPCSTR lpFilename )
{
@@ -618,6 +620,10 @@
* PARAMS
* hdc [I] handle of DC to render in
* hmf [I] handle of metafile to render
+ *
+ * RETURNS
+ * Success: TRUE
+ * Failure: FALSE
*/
BOOL WINAPI PlayMetaFile( HDC hdc, HMETAFILE hmf )
{
@@ -1323,6 +1329,9 @@
*
* PARAMS
* 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 )
{
@@ -1358,6 +1367,10 @@
* PARAMS
* size [I] size of metafile, in bytes
* lpData [I] pointer to metafile data
+ *
+ * RETURNS
+ * Success: Handle to metafile.
+ * Failure: NULL.
*/
HMETAFILE WINAPI SetMetaFileBitsEx( UINT size, const BYTE *lpData )
{
@@ -1390,13 +1403,15 @@
* Get raw metafile data.
*
* 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
* hmf [I] metafile
* nSize [I] size of buf
* 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 )
{
Index: dlls/gdi/painting.c
===================================================================
RCS file: /home/wine/wine/dlls/gdi/painting.c,v
retrieving revision 1.8
diff -u -r1.8 painting.c
--- dlls/gdi/painting.c 11 Oct 2005 19:55:24 -0000 1.8
+++ dlls/gdi/painting.c 4 Nov 2005 14:25:00 -0000
@@ -340,7 +340,9 @@
* iPixelFormat [I] Pixel format index
* ppfd [I] Pixel format for which a match is sought
*
- * RETURNS STD
+ * RETURNS
+ * Success: TRUE
+ * Failure: FALSE
*/
BOOL WINAPI SetPixelFormat( HDC hdc, INT iPixelFormat,
const PIXELFORMATDESCRIPTOR *ppfd)
@@ -433,7 +435,9 @@
* PARAMS
* hdc [I] Device context whose buffers get swapped
*
- * RETURNS STD
+ * RETURNS
+ * Success: TRUE
+ * Failure: FALSE
*/
BOOL WINAPI SwapBuffers( HDC hdc )
{
@@ -689,7 +693,9 @@
* lppt [I] Pointer to 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 )
{
@@ -732,7 +738,9 @@
* lppt [I] Pointer to 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 )
{
@@ -1134,7 +1142,7 @@
}
/******************************************************************************
- * GradientFill (GDI32.@)
+ * GdiGradientFill (GDI32.@)
*
* FIXME: we don't support the Alpha channel properly
*/
Index: dlls/gdi/palette.c
===================================================================
RCS file: /home/wine/wine/dlls/gdi/palette.c,v
retrieving revision 1.9
diff -u -r1.9 palette.c
--- dlls/gdi/palette.c 6 May 2005 15:44:32 -0000 1.9
+++ dlls/gdi/palette.c 4 Nov 2005 14:25:00 -0000
@@ -491,6 +491,8 @@
/***********************************************************************
* SetSystemPaletteUse [GDI32.@]
*
+ * Specify whether the system palette contains 2 or 20 static colors.
+ *
* RETURNS
* Success: Previous system palette
* Failure: SYSPAL_ERROR
Index: dlls/gdi/path.c
===================================================================
RCS file: /home/wine/wine/dlls/gdi/path.c,v
retrieving revision 1.9
diff -u -r1.9 path.c
--- dlls/gdi/path.c 22 Aug 2005 10:19:34 -0000 1.9
+++ dlls/gdi/path.c 4 Nov 2005 14:25:00 -0000
@@ -201,7 +201,9 @@
* PARAMS
* hdc [I] Handle to device context
*
- * RETURNS STD
+ * RETURNS
+ * Success: TRUE
+ * Failure: FALSE
*/
BOOL WINAPI AbortPath( HDC hdc )
{
Index: dlls/gdi/mfdrv/init.c
===================================================================
RCS file: /home/wine/wine/dlls/gdi/mfdrv/init.c,v
retrieving revision 1.34
diff -u -r1.34 init.c
--- dlls/gdi/mfdrv/init.c 11 Apr 2005 12:50:01 -0000 1.34
+++ dlls/gdi/mfdrv/init.c 4 Nov 2005 14:25:00 -0000
@@ -275,6 +275,8 @@
/**********************************************************************
* CreateMetaFileA (GDI32.@)
+ *
+ * See CreateMetaFileW.
*/
HDC WINAPI CreateMetaFileA(LPCSTR filename)
{
More information about the wine-patches
mailing list