Commit 86b67492 authored by Markus Amsler's avatar Markus Amsler Committed by Alexandre Julliard

Improve c2man Documented-Total count. Changes:

- add missing description - add missing returns section - complete missing A/W pairs - reformate comments, to match c2man requirements
parent 7dc54af3
...@@ -510,6 +510,9 @@ void CLASS_AddWindow( CLASS *class, WND *win, WINDOWPROCTYPE type ) ...@@ -510,6 +510,9 @@ void CLASS_AddWindow( CLASS *class, WND *win, WINDOWPROCTYPE type )
/*********************************************************************** /***********************************************************************
* RegisterClassA (USER32.@) * RegisterClassA (USER32.@)
*
* Register a window class.
*
* RETURNS * RETURNS
* >0: Unique identifier * >0: Unique identifier
* 0: Failure * 0: Failure
...@@ -536,6 +539,8 @@ ATOM WINAPI RegisterClassA( const WNDCLASSA* wc ) /* [in] Address of structure w ...@@ -536,6 +539,8 @@ ATOM WINAPI RegisterClassA( const WNDCLASSA* wc ) /* [in] Address of structure w
/*********************************************************************** /***********************************************************************
* RegisterClassW (USER32.@) * RegisterClassW (USER32.@)
*
* See RegisterClassA.
*/ */
ATOM WINAPI RegisterClassW( const WNDCLASSW* wc ) ATOM WINAPI RegisterClassW( const WNDCLASSW* wc )
{ {
......
...@@ -1233,6 +1233,10 @@ HICON16 WINAPI CreateIcon16( HINSTANCE16 hInstance, INT16 nWidth, ...@@ -1233,6 +1233,10 @@ HICON16 WINAPI CreateIcon16( HINSTANCE16 hInstance, INT16 nWidth,
* (*) Windows does not support 15bpp but it supports the 555 RGB 16bpp * (*) Windows does not support 15bpp but it supports the 555 RGB 16bpp
* format! * format!
* *
* RETURNS
* Success: handle to an icon
* Failure: NULL
*
* BUGS * BUGS
* *
* - The provided bitmaps are not resized! * - The provided bitmaps are not resized!
...@@ -1492,7 +1496,10 @@ DWORD WINAPI DumpIcon16( SEGPTR pInfo, WORD *lpLen, ...@@ -1492,7 +1496,10 @@ DWORD WINAPI DumpIcon16( SEGPTR pInfo, WORD *lpLen,
/*********************************************************************** /***********************************************************************
* SetCursor (USER32.@) * SetCursor (USER32.@)
* RETURNS: *
* Set the cursor shape.
*
* RETURNS
* A handle to the previous cursor shape. * A handle to the previous cursor shape.
*/ */
HCURSOR WINAPI SetCursor( HCURSOR hCursor /* [in] Handle of cursor to show */ ) HCURSOR WINAPI SetCursor( HCURSOR hCursor /* [in] Handle of cursor to show */ )
...@@ -2183,7 +2190,7 @@ end: ...@@ -2183,7 +2190,7 @@ end:
/********************************************************************** /**********************************************************************
* LoadImageA (USER32.@) * LoadImageA (USER32.@)
* *
* FIXME: implementation lacks some features, see LR_ defines in winuser.h * See LoadImageW.
*/ */
/* filter for page-fault exceptions */ /* filter for page-fault exceptions */
...@@ -2290,8 +2297,8 @@ HANDLE WINAPI LoadImageW( HINSTANCE hinst, LPCWSTR name, UINT type, ...@@ -2290,8 +2297,8 @@ HANDLE WINAPI LoadImageW( HINSTANCE hinst, LPCWSTR name, UINT type,
* Success: Handle to newly created image * Success: Handle to newly created image
* Failure: NULL * Failure: NULL
* *
* FIXME: implementation still lacks nearly all features, see LR_* * FIXME
* defines in winuser.h * implementation still lacks nearly all features, see LR_* defines in winuser.h.
*/ */
HICON WINAPI CopyImage( HANDLE hnd, UINT type, INT desiredx, HICON WINAPI CopyImage( HANDLE hnd, UINT type, INT desiredx,
INT desiredy, UINT flags ) INT desiredy, UINT flags )
...@@ -2342,6 +2349,8 @@ HBITMAP WINAPI LoadBitmapW( ...@@ -2342,6 +2349,8 @@ HBITMAP WINAPI LoadBitmapW(
/********************************************************************** /**********************************************************************
* LoadBitmapA (USER32.@) * LoadBitmapA (USER32.@)
*
* See LoadBitmapW.
*/ */
HBITMAP WINAPI LoadBitmapA( HINSTANCE instance, LPCSTR name ) HBITMAP WINAPI LoadBitmapA( HINSTANCE instance, LPCSTR name )
{ {
......
...@@ -582,6 +582,8 @@ UINT WDML_Initialize(LPDWORD pidInst, PFNCALLBACK pfnCallback, ...@@ -582,6 +582,8 @@ UINT WDML_Initialize(LPDWORD pidInst, PFNCALLBACK pfnCallback,
/****************************************************************************** /******************************************************************************
* DdeInitializeA (USER32.@) * DdeInitializeA (USER32.@)
*
* See DdeInitializeW.
*/ */
UINT WINAPI DdeInitializeA(LPDWORD pidInst, PFNCALLBACK pfnCallback, UINT WINAPI DdeInitializeA(LPDWORD pidInst, PFNCALLBACK pfnCallback,
DWORD afCmd, DWORD ulRes) DWORD afCmd, DWORD ulRes)
...@@ -1089,9 +1091,7 @@ static HSZ WDML_CreateString(WDML_INSTANCE* pInstance, LPCVOID ptr, int codepage ...@@ -1089,9 +1091,7 @@ static HSZ WDML_CreateString(WDML_INSTANCE* pInstance, LPCVOID ptr, int codepage
/***************************************************************** /*****************************************************************
* DdeCreateStringHandleA [USER32.@] * DdeCreateStringHandleA [USER32.@]
* *
* RETURNS * See DdeCreateStringHandleW.
* Success: String handle
* Failure: 0
*/ */
HSZ WINAPI DdeCreateStringHandleA(DWORD idInst, LPCSTR psz, INT codepage) HSZ WINAPI DdeCreateStringHandleA(DWORD idInst, LPCSTR psz, INT codepage)
{ {
...@@ -1147,8 +1147,9 @@ HSZ WINAPI DdeCreateStringHandleW(DWORD idInst, LPCWSTR psz, INT codepage) ...@@ -1147,8 +1147,9 @@ HSZ WINAPI DdeCreateStringHandleW(DWORD idInst, LPCWSTR psz, INT codepage)
/***************************************************************** /*****************************************************************
* DdeFreeStringHandle (USER32.@) * DdeFreeStringHandle (USER32.@)
* RETURNS: success: nonzero * RETURNS
* fail: zero * success: nonzero
* fail: zero
*/ */
BOOL WINAPI DdeFreeStringHandle(DWORD idInst, HSZ hsz) BOOL WINAPI DdeFreeStringHandle(DWORD idInst, HSZ hsz)
{ {
...@@ -1173,8 +1174,9 @@ BOOL WINAPI DdeFreeStringHandle(DWORD idInst, HSZ hsz) ...@@ -1173,8 +1174,9 @@ BOOL WINAPI DdeFreeStringHandle(DWORD idInst, HSZ hsz)
/***************************************************************** /*****************************************************************
* DdeKeepStringHandle (USER32.@) * DdeKeepStringHandle (USER32.@)
* *
* RETURNS: success: nonzero * RETURNS
* fail: zero * success: nonzero
* fail: zero
*/ */
BOOL WINAPI DdeKeepStringHandle(DWORD idInst, HSZ hsz) BOOL WINAPI DdeKeepStringHandle(DWORD idInst, HSZ hsz)
{ {
...@@ -1201,10 +1203,14 @@ BOOL WINAPI DdeKeepStringHandle(DWORD idInst, HSZ hsz) ...@@ -1201,10 +1203,14 @@ BOOL WINAPI DdeKeepStringHandle(DWORD idInst, HSZ hsz)
* Compares the value of two string handles. This comparison is * Compares the value of two string handles. This comparison is
* not case sensitive. * not case sensitive.
* *
* Returns: * PARAMS
* -1 The value of hsz1 is zero or less than hsz2 * hsz1 [I] Handle to the first string
* 0 The values of hsz 1 and 2 are the same or both zero. * hsz2 [I] Handle to the second string
* 1 The value of hsz2 is zero of less than hsz1 *
* 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) INT WINAPI DdeCmpStringHandles(HSZ hsz1, HSZ hsz2)
{ {
......
...@@ -716,6 +716,7 @@ static LRESULT DEFWND_DefWinProc( HWND hwnd, UINT msg, WPARAM wParam, LPARAM lPa ...@@ -716,6 +716,7 @@ static LRESULT DEFWND_DefWinProc( HWND hwnd, UINT msg, WPARAM wParam, LPARAM lPa
/*********************************************************************** /***********************************************************************
* DefWindowProcA (USER32.@) * DefWindowProcA (USER32.@)
* *
* See DefWindowProcW.
*/ */
LRESULT WINAPI DefWindowProcA( HWND hwnd, UINT msg, WPARAM wParam, LPARAM lParam ) LRESULT WINAPI DefWindowProcA( HWND hwnd, UINT msg, WPARAM wParam, LPARAM lParam )
{ {
......
...@@ -4802,8 +4802,8 @@ static BOOL translate_accelerator( HWND hWnd, UINT message, WPARAM wParam, LPARA ...@@ -4802,8 +4802,8 @@ static BOOL translate_accelerator( HWND hWnd, UINT message, WPARAM wParam, LPARA
} }
/********************************************************************** /**********************************************************************
* TranslateAccelerator (USER32.@)
* TranslateAcceleratorA (USER32.@) * TranslateAcceleratorA (USER32.@)
* TranslateAccelerator (USER32.@)
*/ */
INT WINAPI TranslateAcceleratorA( HWND hWnd, HACCEL hAccel, LPMSG msg ) INT WINAPI TranslateAcceleratorA( HWND hWnd, HACCEL hAccel, LPMSG msg )
{ {
......
...@@ -2810,8 +2810,8 @@ BOOL WINAPI GetMessageA( MSG *msg, HWND hwnd, UINT first, UINT last ) ...@@ -2810,8 +2810,8 @@ BOOL WINAPI GetMessageA( MSG *msg, HWND hwnd, UINT first, UINT last )
/*********************************************************************** /***********************************************************************
* IsDialogMessage (USER32.@)
* IsDialogMessageA (USER32.@) * IsDialogMessageA (USER32.@)
* IsDialogMessage (USER32.@)
*/ */
BOOL WINAPI IsDialogMessageA( HWND hwndDlg, LPMSG pmsg ) BOOL WINAPI IsDialogMessageA( HWND hwndDlg, LPMSG pmsg )
{ {
...@@ -2873,6 +2873,8 @@ BOOL WINAPI TranslateMessage( const MSG *msg ) ...@@ -2873,6 +2873,8 @@ BOOL WINAPI TranslateMessage( const MSG *msg )
/*********************************************************************** /***********************************************************************
* DispatchMessageA (USER32.@) * DispatchMessageA (USER32.@)
*
* See DispatchMessageW.
*/ */
LONG WINAPI DispatchMessageA( const MSG* msg ) LONG WINAPI DispatchMessageA( const MSG* msg )
{ {
...@@ -3203,8 +3205,8 @@ void WINAPI UserYield16(void) ...@@ -3203,8 +3205,8 @@ void WINAPI UserYield16(void)
/*********************************************************************** /***********************************************************************
* RegisterWindowMessage (USER.118)
* RegisterWindowMessageA (USER32.@) * RegisterWindowMessageA (USER32.@)
* RegisterWindowMessage (USER.118)
*/ */
UINT WINAPI RegisterWindowMessageA( LPCSTR str ) UINT WINAPI RegisterWindowMessageA( LPCSTR str )
{ {
...@@ -3226,8 +3228,8 @@ UINT WINAPI RegisterWindowMessageW( LPCWSTR str ) ...@@ -3226,8 +3228,8 @@ UINT WINAPI RegisterWindowMessageW( LPCWSTR str )
/*********************************************************************** /***********************************************************************
* BroadcastSystemMessage (USER32.@)
* BroadcastSystemMessageA (USER32.@) * BroadcastSystemMessageA (USER32.@)
* BroadcastSystemMessage (USER32.@)
*/ */
LONG WINAPI BroadcastSystemMessageA( DWORD flags, LPDWORD recipients, UINT msg, WPARAM wp, LPARAM lp ) LONG WINAPI BroadcastSystemMessageA( DWORD flags, LPDWORD recipients, UINT msg, WPARAM wp, LPARAM lp )
{ {
......
...@@ -190,6 +190,9 @@ BOOL WINAPI GetAltTabInfoW(HWND hwnd, int iItem, PALTTABINFO pati, LPWSTR pszIte ...@@ -190,6 +190,9 @@ BOOL WINAPI GetAltTabInfoW(HWND hwnd, int iItem, PALTTABINFO pati, LPWSTR pszIte
* *
* PARAMS * PARAMS
* dwLevel [I] Debugging error level * dwLevel [I] Debugging error level
*
* RETURNS
* Nothing.
*/ */
VOID WINAPI SetDebugErrorLevel( DWORD dwLevel ) VOID WINAPI SetDebugErrorLevel( DWORD dwLevel )
{ {
......
...@@ -296,7 +296,9 @@ HACCEL WINAPI CreateAcceleratorTableW(LPACCEL lpaccel, INT cEntries) ...@@ -296,7 +296,9 @@ HACCEL WINAPI CreateAcceleratorTableW(LPACCEL lpaccel, INT cEntries)
* PARAMS * PARAMS
* handle [I] Handle to accelerator table * handle [I] Handle to accelerator table
* *
* RETURNS STD * RETURNS
* Success: TRUE
* Failure: FALSE
*/ */
BOOL WINAPI DestroyAcceleratorTable( HACCEL handle ) BOOL WINAPI DestroyAcceleratorTable( HACCEL handle )
{ {
......
...@@ -1324,7 +1324,9 @@ static INT SCROLL_GetScrollPos(HWND hwnd, INT nBar) ...@@ -1324,7 +1324,9 @@ static INT SCROLL_GetScrollPos(HWND hwnd, INT nBar)
* lpMin [O] Where to store minimum value * lpMin [O] Where to store minimum value
* lpMax [O] Where to store maximum 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) static BOOL SCROLL_GetScrollRange(HWND hwnd, INT nBar, LPINT lpMin, LPINT lpMax)
{ {
...@@ -1859,7 +1861,9 @@ INT WINAPI GetScrollPos(HWND hwnd, INT nBar) ...@@ -1859,7 +1861,9 @@ INT WINAPI GetScrollPos(HWND hwnd, INT nBar)
* maxVal [I] New Maximum value * maxVal [I] New Maximum value
* bRedraw [I] Should scrollbar be redrawn afterwards? * 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) BOOL WINAPI SetScrollRange(HWND hwnd, INT nBar, INT minVal, INT maxVal, BOOL bRedraw)
{ {
...@@ -1984,7 +1988,9 @@ static BOOL SCROLL_ShowScrollBar( HWND hwnd, INT nBar, BOOL fShowH, BOOL fShowV ...@@ -1984,7 +1988,9 @@ static BOOL SCROLL_ShowScrollBar( HWND hwnd, INT nBar, BOOL fShowH, BOOL fShowV
* nBar [I] One of SB_HORZ, SB_VERT, or SB_CTL * nBar [I] One of SB_HORZ, SB_VERT, or SB_CTL
* fShow [I] TRUE = show, FALSE = hide * fShow [I] TRUE = show, FALSE = hide
* *
* RETURNS STD * RETURNS
* Success: TRUE
* Failure: FALSE
*/ */
BOOL WINAPI ShowScrollBar(HWND hwnd, INT nBar, BOOL fShow) BOOL WINAPI ShowScrollBar(HWND hwnd, INT nBar, BOOL fShow)
{ {
......
...@@ -2127,6 +2127,8 @@ LONG WINAPI SetWindowLong16( HWND16 hwnd, INT16 offset, LONG newval ) ...@@ -2127,6 +2127,8 @@ LONG WINAPI SetWindowLong16( HWND16 hwnd, INT16 offset, LONG newval )
/********************************************************************** /**********************************************************************
* SetWindowLongA (USER32.@) * SetWindowLongA (USER32.@)
*
* See SetWindowLongW.
*/ */
LONG WINAPI SetWindowLongA( HWND hwnd, INT offset, LONG newval ) LONG WINAPI SetWindowLongA( HWND hwnd, INT offset, LONG newval )
{ {
...@@ -2274,8 +2276,8 @@ INT WINAPI GetWindowTextW( HWND hwnd, LPWSTR lpString, INT nMaxCount ) ...@@ -2274,8 +2276,8 @@ INT WINAPI GetWindowTextW( HWND hwnd, LPWSTR lpString, INT nMaxCount )
/******************************************************************* /*******************************************************************
* SetWindowText (USER32.@)
* SetWindowTextA (USER32.@) * SetWindowTextA (USER32.@)
* SetWindowText (USER32.@)
*/ */
BOOL WINAPI SetWindowTextA( HWND hwnd, LPCSTR lpString ) BOOL WINAPI SetWindowTextA( HWND hwnd, LPCSTR lpString )
{ {
......
...@@ -3293,6 +3293,8 @@ LRESULT WINAPI CallWindowProcA( ...@@ -3293,6 +3293,8 @@ LRESULT WINAPI CallWindowProcA(
/********************************************************************** /**********************************************************************
* CallWindowProcW (USER32.@) * CallWindowProcW (USER32.@)
*
* See CallWindowProcA.
*/ */
LRESULT WINAPI CallWindowProcW( WNDPROC func, HWND hwnd, UINT msg, LRESULT WINAPI CallWindowProcW( WNDPROC func, HWND hwnd, UINT msg,
WPARAM wParam, LPARAM lParam ) WPARAM wParam, LPARAM lParam )
......
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment