user: improve c2man documentation
Markus Amsler
markus.amsler at oribi.org
Tue Nov 8 18:26:33 CST 2005
This patch improves the c2man Documented-Total count of user32 from
46(6%) to 62(9%)
Changelog:
Markus Amsler <markus.amsler at oribi.org>
Improve c2man Documented-Total count. Changes:
- add missing description
- add missing returns section
- complete missing A/W pairs
- reformate comments, to match c2man requirements
-------------- next part --------------
Index: dlls/user/class.c
===================================================================
RCS file: /home/wine/wine/dlls/user/class.c,v
retrieving revision 1.1
diff -u -r1.1 class.c
--- dlls/user/class.c 25 Apr 2005 11:33:36 -0000 1.1
+++ dlls/user/class.c 9 Nov 2005 00:30:28 -0000
@@ -510,6 +510,9 @@
/***********************************************************************
* RegisterClassA (USER32.@)
+ *
+ * Register a window class.
+ *
* RETURNS
* >0: Unique identifier
* 0: Failure
@@ -536,6 +539,8 @@
/***********************************************************************
* RegisterClassW (USER32.@)
+ *
+ * See RegisterClassA.
*/
ATOM WINAPI RegisterClassW( const WNDCLASSW* wc )
{
Index: dlls/user/cursoricon.c
===================================================================
RCS file: /home/wine/wine/dlls/user/cursoricon.c,v
retrieving revision 1.18
diff -u -r1.18 cursoricon.c
--- dlls/user/cursoricon.c 7 Nov 2005 11:07:43 -0000 1.18
+++ dlls/user/cursoricon.c 9 Nov 2005 00:30:29 -0000
@@ -1233,6 +1233,10 @@
* (*) Windows does not support 15bpp but it supports the 555 RGB 16bpp
* format!
*
+ * RETURNS
+ * Success: handle to an icon
+ * Failure: NULL
+ *
* BUGS
*
* - The provided bitmaps are not resized!
@@ -1492,7 +1496,10 @@
/***********************************************************************
* SetCursor (USER32.@)
- * RETURNS:
+ *
+ * Set the cursor shape.
+ *
+ * RETURNS
* A handle to the previous cursor shape.
*/
HCURSOR WINAPI SetCursor( HCURSOR hCursor /* [in] Handle of cursor to show */ )
@@ -2183,7 +2190,7 @@
/**********************************************************************
* LoadImageA (USER32.@)
*
- * FIXME: implementation lacks some features, see LR_ defines in winuser.h
+ * See LoadImageW.
*/
/* filter for page-fault exceptions */
@@ -2290,8 +2297,8 @@
* Success: Handle to newly created image
* Failure: NULL
*
- * FIXME: implementation still lacks nearly all features, see LR_*
- * defines in winuser.h
+ * FIXME
+ * implementation still lacks nearly all features, see LR_* defines in winuser.h.
*/
HICON WINAPI CopyImage( HANDLE hnd, UINT type, INT desiredx,
INT desiredy, UINT flags )
@@ -2342,6 +2349,8 @@
/**********************************************************************
* LoadBitmapA (USER32.@)
+ *
+ * See LoadBitmapW.
*/
HBITMAP WINAPI LoadBitmapA( HINSTANCE instance, LPCSTR name )
{
Index: dlls/user/dde_misc.c
===================================================================
RCS file: /home/wine/wine/dlls/user/dde_misc.c,v
retrieving revision 1.6
diff -u -r1.6 dde_misc.c
--- dlls/user/dde_misc.c 20 Sep 2005 11:39:19 -0000 1.6
+++ dlls/user/dde_misc.c 9 Nov 2005 00:30:29 -0000
@@ -582,6 +582,8 @@
/******************************************************************************
* DdeInitializeA (USER32.@)
+ *
+ * See DdeInitializeW.
*/
UINT WINAPI DdeInitializeA(LPDWORD pidInst, PFNCALLBACK pfnCallback,
DWORD afCmd, DWORD ulRes)
@@ -1089,9 +1091,7 @@
/*****************************************************************
* DdeCreateStringHandleA [USER32.@]
*
- * RETURNS
- * Success: String handle
- * Failure: 0
+ * See DdeCreateStringHandleW.
*/
HSZ WINAPI DdeCreateStringHandleA(DWORD idInst, LPCSTR psz, INT codepage)
{
@@ -1147,8 +1147,9 @@
/*****************************************************************
* DdeFreeStringHandle (USER32.@)
- * RETURNS: success: nonzero
- * fail: zero
+ * RETURNS
+ * success: nonzero
+ * fail: zero
*/
BOOL WINAPI DdeFreeStringHandle(DWORD idInst, HSZ hsz)
{
@@ -1173,8 +1174,9 @@
/*****************************************************************
* DdeKeepStringHandle (USER32.@)
*
- * RETURNS: success: nonzero
- * fail: zero
+ * RETURNS
+ * success: nonzero
+ * fail: zero
*/
BOOL WINAPI DdeKeepStringHandle(DWORD idInst, HSZ hsz)
{
@@ -1201,10 +1203,14 @@
* Compares the value of two string handles. This comparison is
* not case sensitive.
*
- * Returns:
- * -1 The value of hsz1 is zero or less than hsz2
- * 0 The values of hsz 1 and 2 are the same or both zero.
- * 1 The value of hsz2 is zero of less than hsz1
+ * PARAMS
+ * hsz1 [I] Handle to the first string
+ * hsz2 [I] Handle to the second string
+ *
+ * RETURNS
+ * -1 The value of hsz1 is zero or less than hsz2
+ * 0 The values of hsz 1 and 2 are the same or both zero.
+ * 1 The value of hsz2 is zero of less than hsz1
*/
INT WINAPI DdeCmpStringHandles(HSZ hsz1, HSZ hsz2)
{
Index: dlls/user/defwnd.c
===================================================================
RCS file: /home/wine/wine/dlls/user/defwnd.c,v
retrieving revision 1.6
diff -u -r1.6 defwnd.c
--- dlls/user/defwnd.c 29 Sep 2005 13:36:14 -0000 1.6
+++ dlls/user/defwnd.c 9 Nov 2005 00:30:29 -0000
@@ -716,6 +716,7 @@
/***********************************************************************
* DefWindowProcA (USER32.@)
*
+ * See DefWindowProcW.
*/
LRESULT WINAPI DefWindowProcA( HWND hwnd, UINT msg, WPARAM wParam, LPARAM lParam )
{
Index: dlls/user/menu.c
===================================================================
RCS file: /home/wine/wine/dlls/user/menu.c,v
retrieving revision 1.40
diff -u -r1.40 menu.c
--- dlls/user/menu.c 26 Sep 2005 09:57:38 -0000 1.40
+++ dlls/user/menu.c 9 Nov 2005 00:30:30 -0000
@@ -4802,8 +4802,8 @@
}
/**********************************************************************
- * TranslateAccelerator (USER32.@)
* TranslateAcceleratorA (USER32.@)
+ * TranslateAccelerator (USER32.@)
*/
INT WINAPI TranslateAcceleratorA( HWND hWnd, HACCEL hAccel, LPMSG msg )
{
Index: dlls/user/message.c
===================================================================
RCS file: /home/wine/wine/dlls/user/message.c,v
retrieving revision 1.96
diff -u -r1.96 message.c
--- dlls/user/message.c 27 Oct 2005 18:28:23 -0000 1.96
+++ dlls/user/message.c 9 Nov 2005 00:30:31 -0000
@@ -2810,8 +2810,8 @@
/***********************************************************************
- * IsDialogMessage (USER32.@)
* IsDialogMessageA (USER32.@)
+ * IsDialogMessage (USER32.@)
*/
BOOL WINAPI IsDialogMessageA( HWND hwndDlg, LPMSG pmsg )
{
@@ -2873,6 +2873,8 @@
/***********************************************************************
* DispatchMessageA (USER32.@)
+ *
+ * See DispatchMessageW.
*/
LONG WINAPI DispatchMessageA( const MSG* msg )
{
@@ -3203,8 +3205,8 @@
/***********************************************************************
- * RegisterWindowMessage (USER.118)
* RegisterWindowMessageA (USER32.@)
+ * RegisterWindowMessage (USER.118)
*/
UINT WINAPI RegisterWindowMessageA( LPCSTR str )
{
@@ -3226,8 +3228,8 @@
/***********************************************************************
- * BroadcastSystemMessage (USER32.@)
* BroadcastSystemMessageA (USER32.@)
+ * BroadcastSystemMessage (USER32.@)
*/
LONG WINAPI BroadcastSystemMessageA( DWORD flags, LPDWORD recipients, UINT msg, WPARAM wp, LPARAM lp )
{
Index: dlls/user/misc.c
===================================================================
RCS file: /home/wine/wine/dlls/user/misc.c,v
retrieving revision 1.28
diff -u -r1.28 misc.c
--- dlls/user/misc.c 3 Oct 2005 10:17:05 -0000 1.28
+++ dlls/user/misc.c 9 Nov 2005 00:30:31 -0000
@@ -190,6 +190,9 @@
*
* PARAMS
* dwLevel [I] Debugging error level
+ *
+ * RETURNS
+ * Nothing.
*/
VOID WINAPI SetDebugErrorLevel( DWORD dwLevel )
{
Index: dlls/user/resource.c
===================================================================
RCS file: /home/wine/wine/dlls/user/resource.c,v
retrieving revision 1.28
diff -u -r1.28 resource.c
--- dlls/user/resource.c 12 Sep 2005 14:12:46 -0000 1.28
+++ dlls/user/resource.c 9 Nov 2005 00:30:32 -0000
@@ -296,7 +296,9 @@
* PARAMS
* handle [I] Handle to accelerator table
*
- * RETURNS STD
+ * RETURNS
+ * Success: TRUE
+ * Failure: FALSE
*/
BOOL WINAPI DestroyAcceleratorTable( HACCEL handle )
{
Index: dlls/user/scroll.c
===================================================================
RCS file: /home/wine/wine/dlls/user/scroll.c,v
retrieving revision 1.16
diff -u -r1.16 scroll.c
--- dlls/user/scroll.c 3 Nov 2005 09:51:42 -0000 1.16
+++ dlls/user/scroll.c 9 Nov 2005 00:30:32 -0000
@@ -1324,7 +1324,9 @@
* lpMin [O] Where to store minimum value
* lpMax [O] Where to store maximum value
*
- * RETURNS STD
+ * RETURNS
+ * Success: TRUE
+ * Failure: FALSE
*/
static BOOL SCROLL_GetScrollRange(HWND hwnd, INT nBar, LPINT lpMin, LPINT lpMax)
{
@@ -1859,7 +1861,9 @@
* maxVal [I] New Maximum value
* bRedraw [I] Should scrollbar be redrawn afterwards?
*
- * RETURNS STD
+ * RETURNS
+ * Success: TRUE
+ * Failure: FALSE
*/
BOOL WINAPI SetScrollRange(HWND hwnd, INT nBar, INT minVal, INT maxVal, BOOL bRedraw)
{
@@ -1984,7 +1988,9 @@
* nBar [I] One of SB_HORZ, SB_VERT, or SB_CTL
* fShow [I] TRUE = show, FALSE = hide
*
- * RETURNS STD
+ * RETURNS
+ * Success: TRUE
+ * Failure: FALSE
*/
BOOL WINAPI ShowScrollBar(HWND hwnd, INT nBar, BOOL fShow)
{
Index: dlls/user/win.c
===================================================================
RCS file: /home/wine/wine/dlls/user/win.c,v
retrieving revision 1.20
diff -u -r1.20 win.c
--- dlls/user/win.c 3 Oct 2005 18:48:36 -0000 1.20
+++ dlls/user/win.c 9 Nov 2005 00:30:33 -0000
@@ -2127,6 +2127,8 @@
/**********************************************************************
* SetWindowLongA (USER32.@)
+ *
+ * See SetWindowLongW.
*/
LONG WINAPI SetWindowLongA( HWND hwnd, INT offset, LONG newval )
{
@@ -2274,8 +2276,8 @@
/*******************************************************************
- * SetWindowText (USER32.@)
* SetWindowTextA (USER32.@)
+ * SetWindowText (USER32.@)
*/
BOOL WINAPI SetWindowTextA( HWND hwnd, LPCSTR lpString )
{
Index: dlls/user/winproc.c
===================================================================
RCS file: /home/wine/wine/dlls/user/winproc.c,v
retrieving revision 1.12
diff -u -r1.12 winproc.c
--- dlls/user/winproc.c 21 Oct 2005 15:43:09 -0000 1.12
+++ dlls/user/winproc.c 9 Nov 2005 00:30:34 -0000
@@ -3293,6 +3293,8 @@
/**********************************************************************
* CallWindowProcW (USER32.@)
+ *
+ * See CallWindowProcA.
*/
LRESULT WINAPI CallWindowProcW( WNDPROC func, HWND hwnd, UINT msg,
WPARAM wParam, LPARAM lParam )
More information about the wine-patches
mailing list