From 4008065c04148d87b7f63df25c788e174b5eff62 Mon Sep 17 00:00:00 2001 From: Markus Amsler Date: Sat, 12 Nov 2005 19:12:25 +0000 Subject: [PATCH] Improve c2man Documented-Total count. Changes: - add missing description - complete missing A/W pairs - document remaining comdlg32 functions --- dlls/commdlg/cdlg32.c | 2 +- dlls/commdlg/colordlg.c | 12 ++++++++++++ dlls/commdlg/filetitle.c | 11 +++++++++++ dlls/commdlg/finddlg32.c | 16 ++++++++++------ dlls/commdlg/fontdlg.c | 12 ++++++++++++ dlls/commdlg/printdlg.c | 28 ++++++++++++++++++++++++++++ 6 files changed, 74 insertions(+), 7 deletions(-) diff --git a/dlls/commdlg/cdlg32.c b/dlls/commdlg/cdlg32.c index 2f45eda4476..d2d5aa3ce03 100644 --- a/dlls/commdlg/cdlg32.c +++ b/dlls/commdlg/cdlg32.c @@ -165,8 +165,8 @@ void COMDLG32_SetCommDlgExtendedError(DWORD err) /*********************************************************************** - * CommDlgExtendedError (COMMDLG.26) * CommDlgExtendedError (COMDLG32.@) + * CommDlgExtendedError (COMMDLG.26) * * Get the thread's local error value if a comdlg32 function fails. * RETURNS diff --git a/dlls/commdlg/colordlg.c b/dlls/commdlg/colordlg.c index 902de60ea4e..99061d199ec 100644 --- a/dlls/commdlg/colordlg.c +++ b/dlls/commdlg/colordlg.c @@ -1249,6 +1249,16 @@ static INT_PTR CALLBACK ColorDlgProc( HWND hDlg, UINT message, /*********************************************************************** * ChooseColorW (COMDLG32.@) + * + * Create a color dialog box. + * + * PARAMS + * lpChCol [I/O] in: information to initialize the dialog box. + * out: User's color selection + * + * RETURNS + * TRUE: Ok button clicked. + * FALSE: Cancel button clicked, or error. */ BOOL WINAPI ChooseColorW( LPCHOOSECOLORW lpChCol ) { @@ -1309,6 +1319,8 @@ BOOL WINAPI ChooseColorW( LPCHOOSECOLORW lpChCol ) /*********************************************************************** * ChooseColorA (COMDLG32.@) + * + * See ChooseColorW. */ BOOL WINAPI ChooseColorA( LPCHOOSECOLORA lpChCol ) diff --git a/dlls/commdlg/filetitle.c b/dlls/commdlg/filetitle.c index 5b2f4bf802e..95ce5390ac4 100644 --- a/dlls/commdlg/filetitle.c +++ b/dlls/commdlg/filetitle.c @@ -40,6 +40,7 @@ WINE_DEFAULT_DEBUG_CHANNEL(commdlg); /*********************************************************************** * GetFileTitleA (COMDLG32.@) * + * See GetFileTitleW. */ short WINAPI GetFileTitleA(LPCSTR lpFile, LPSTR lpTitle, WORD cbBuf) { @@ -60,6 +61,16 @@ short WINAPI GetFileTitleA(LPCSTR lpFile, LPSTR lpTitle, WORD cbBuf) /*********************************************************************** * GetFileTitleW (COMDLG32.@) * + * Get the name of a file. + * + * PARAMS + * lpFile [I] name and location of file + * lpTitle [O] returned file name + * cbBuf [I] buffer size of lpTitle + * + * RETURNS + * Success: zero + * Failure: negative number. */ short WINAPI GetFileTitleW(LPCWSTR lpFile, LPWSTR lpTitle, WORD cbBuf) { diff --git a/dlls/commdlg/finddlg32.c b/dlls/commdlg/finddlg32.c index 6863ef7af36..20f9e34fae6 100644 --- a/dlls/commdlg/finddlg32.c +++ b/dlls/commdlg/finddlg32.c @@ -440,9 +440,8 @@ cleanup: /*********************************************************************** * FindTextA [COMDLG32.@] - * RETURNS - * Window handle to created dialog: Success - * NULL: Failure + * + * See FindTextW. */ HWND WINAPI FindTextA( LPFINDREPLACEA pfr /* [in] Find/replace structure*/ @@ -464,9 +463,8 @@ HWND WINAPI FindTextA( /*********************************************************************** * ReplaceTextA [COMDLG32.@] - * RETURNS - * Window handle to created dialog: Success - * NULL: Failure + * + * See ReplaceTextW. */ HWND WINAPI ReplaceTextA( LPFINDREPLACEA pfr /* [in] Find/replace structure*/ @@ -489,6 +487,9 @@ HWND WINAPI ReplaceTextA( /*********************************************************************** * FindTextW [COMDLG32.@] + * + * Create a modeless find-text dialog box. + * * RETURNS * Window handle to created dialog: Success * NULL: Failure @@ -520,6 +521,9 @@ HWND WINAPI FindTextW( /*********************************************************************** * ReplaceTextW [COMDLG32.@] + * + * Create a modeless replace-text dialog box. + * * RETURNS * Window handle to created dialog: Success * NULL: Failure diff --git a/dlls/commdlg/fontdlg.c b/dlls/commdlg/fontdlg.c index 96894b570e7..1f9980bd83a 100644 --- a/dlls/commdlg/fontdlg.c +++ b/dlls/commdlg/fontdlg.c @@ -160,6 +160,16 @@ void _dump_cf_flags(DWORD cflags) /*********************************************************************** * ChooseFontW (COMDLG32.@) + * + * Create a font dialog box. + * + * PARAMS + * lpChFont [I/O] in: information to initialize the dialog box. + * out: User's color selection + * + * RETURNS + * TRUE: Ok button clicked. + * FALSE: Cancel button clicked, or error. */ BOOL WINAPI ChooseFontW(LPCHOOSEFONTW lpChFont) { @@ -212,6 +222,8 @@ BOOL WINAPI ChooseFontW(LPCHOOSEFONTW lpChFont) /*********************************************************************** * ChooseFontA (COMDLG32.@) + * + * See ChosseFontW. */ BOOL WINAPI ChooseFontA(LPCHOOSEFONTA lpChFont) { diff --git a/dlls/commdlg/printdlg.c b/dlls/commdlg/printdlg.c index 690a0b71641..cf36ef03555 100644 --- a/dlls/commdlg/printdlg.c +++ b/dlls/commdlg/printdlg.c @@ -2140,6 +2140,8 @@ BOOL WINAPI PrintDlgA(LPPRINTDLGA lppd) /*********************************************************************** * PrintDlgW (COMDLG32.@) + * + * See PrintDlgA. */ BOOL WINAPI PrintDlgW( LPPRINTDLGW lppd /* [in/out] ptr to PRINTDLG32 struct */ @@ -3414,6 +3416,8 @@ BOOL WINAPI PageSetupDlgA(LPPAGESETUPDLGA setupdlg) { } /*********************************************************************** * PageSetupDlgW (COMDLG32.@) + * + * See PageSetupDlgA. */ BOOL WINAPI PageSetupDlgW(LPPAGESETUPDLGW setupdlg) { HGLOBAL hDlgTmpl; @@ -3483,6 +3487,11 @@ BOOL WINAPI PageSetupDlgW(LPPAGESETUPDLGW setupdlg) { /*********************************************************************** * PrintDlgExA (COMDLG32.@) + * + * See PrintDlgExW. + * + * FIXME + * Stub */ HRESULT WINAPI PrintDlgExA(LPPRINTDLGEXA lpPrintDlgExA) { @@ -3492,6 +3501,25 @@ HRESULT WINAPI PrintDlgExA(LPPRINTDLGEXA lpPrintDlgExA) /*********************************************************************** * PrintDlgExW (COMDLG32.@) + * + * Display the the PRINT dialog box, which enables the user to specify + * specific properties of the print job. The property sheet can also have + * additional application-specific and driver-specific property pages. + * + * PARAMS + * lppd [IO] ptr to PRINTDLGEX struct + * + * RETURNS + * Success: S_OK + * Failure: One of the following COM error codes: + * E_OUTOFMEMORY Insufficient memory. + * E_INVALIDARG One or more arguments are invalid. + * E_POINTER Invalid pointer. + * E_HANDLE Invalid handle. + * E_FAIL Unspecified error. + * + * FIXME + * Stub */ HRESULT WINAPI PrintDlgExW(LPPRINTDLGEXW lpPrintDlgExW) {