commdlg: doc update

[Markus Amsler]

Perhaps the first case of overdocumentation :-)
This patch improves the c2man Documented-Total count of comdlg32 from 
6(28%) to 22(104%)!
There's a bug in c2man if 2 functions in different dlls have the same 
name. Here CommDlgExtendedError in commdlg an comdlg32.

Changelog:
Markus Amsler <markus.amsler at oribi.org>
Improve c2man Documented-Total count. Changes:
  - add missing description
  - complete missing A/W pairs
  - document remaining comdlg32 functions

-------------- next part --------------
Index: dlls/commdlg/cdlg32.c
===================================================================
RCS file: /home/wine/wine/dlls/commdlg/cdlg32.c,v
retrieving revision 1.33
diff -u -r1.33 cdlg32.c
--- dlls/commdlg/cdlg32.c	2 Sep 2005 11:33:51 -0000	1.33
+++ dlls/commdlg/cdlg32.c	12 Nov 2005 08:00:09 -0000
@@ -165,8 +165,8 @@
 
 
 /***********************************************************************
- *	CommDlgExtendedError			(COMMDLG.26)
  *	CommDlgExtendedError			(COMDLG32.@)
+ *	CommDlgExtendedError			(COMMDLG.26)
  *
  * Get the thread's local error value if a comdlg32 function fails.
  *	RETURNS
Index: dlls/commdlg/colordlg.c
===================================================================
RCS file: /home/wine/wine/dlls/commdlg/colordlg.c,v
retrieving revision 1.53
diff -u -r1.53 colordlg.c
--- dlls/commdlg/colordlg.c	2 Sep 2005 11:33:51 -0000	1.53
+++ dlls/commdlg/colordlg.c	12 Nov 2005 08:00:09 -0000
@@ -1249,6 +1249,16 @@
 
 /***********************************************************************
  *            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 @@
 
 /***********************************************************************
  *            ChooseColorA  (COMDLG32.@)
+ *
+ * See ChooseColorW.
  */
 BOOL WINAPI ChooseColorA( LPCHOOSECOLORA lpChCol )
 
Index: dlls/commdlg/filetitle.c
===================================================================
RCS file: /home/wine/wine/dlls/commdlg/filetitle.c,v
retrieving revision 1.18
diff -u -r1.18 filetitle.c
--- dlls/commdlg/filetitle.c	10 Nov 2005 12:14:59 -0000	1.18
+++ dlls/commdlg/filetitle.c	12 Nov 2005 08:00:09 -0000
@@ -40,6 +40,7 @@
 /***********************************************************************
  *	GetFileTitleA		(COMDLG32.@)
  *
+ * See GetFileTitleW.
  */
 short WINAPI GetFileTitleA(LPCSTR lpFile, LPSTR lpTitle, WORD cbBuf)
 {
@@ -60,6 +61,16 @@
 /***********************************************************************
  *	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)
 {
Index: dlls/commdlg/finddlg32.c
===================================================================
RCS file: /home/wine/wine/dlls/commdlg/finddlg32.c,v
retrieving revision 1.23
diff -u -r1.23 finddlg32.c
--- dlls/commdlg/finddlg32.c	6 Jan 2004 22:08:34 -0000	1.23
+++ dlls/commdlg/finddlg32.c	12 Nov 2005 08:00:09 -0000
@@ -440,9 +440,8 @@
 
 /***********************************************************************
  *	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 @@
 
 /***********************************************************************
  *	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 @@
 
 /***********************************************************************
  *	FindTextW 				[COMDLG32.@]
+ *
+ * Create a modeless find-text dialog box.
+ *
  *	RETURNS
  *		Window handle to created dialog: Success
  *		NULL: Failure
@@ -520,6 +521,9 @@
 
 /***********************************************************************
  *	ReplaceTextW 				[COMDLG32.@]
+ *
+ * Create a modeless replace-text dialog box.
+ *
  *	RETURNS
  *		Window handle to created dialog: Success
  *		NULL: Failure
Index: dlls/commdlg/fontdlg.c
===================================================================
RCS file: /home/wine/wine/dlls/commdlg/fontdlg.c,v
retrieving revision 1.81
diff -u -r1.81 fontdlg.c
--- dlls/commdlg/fontdlg.c	2 Sep 2005 11:33:51 -0000	1.81
+++ dlls/commdlg/fontdlg.c	12 Nov 2005 08:00:10 -0000
@@ -160,6 +160,16 @@
 
 /***********************************************************************
  *           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 @@
 
 /***********************************************************************
  *           ChooseFontA   (COMDLG32.@)
+ *
+ * See ChosseFontW.
  */
 BOOL WINAPI ChooseFontA(LPCHOOSEFONTA lpChFont)
 {
Index: dlls/commdlg/printdlg.c
===================================================================
RCS file: /home/wine/wine/dlls/commdlg/printdlg.c,v
retrieving revision 1.97
diff -u -r1.97 printdlg.c
--- dlls/commdlg/printdlg.c	3 Nov 2005 12:12:18 -0000	1.97
+++ dlls/commdlg/printdlg.c	12 Nov 2005 08:00:11 -0000
@@ -2140,6 +2140,8 @@
 
 /***********************************************************************
  *           PrintDlgW   (COMDLG32.@)
+ *
+ * See PrintDlgA.
  */
 BOOL WINAPI PrintDlgW(
 		      LPPRINTDLGW lppd /* [in/out] ptr to PRINTDLG32 struct */
@@ -3414,6 +3416,8 @@
 }
 /***********************************************************************
  *            PageSetupDlgW  (COMDLG32.@)
+ *
+ * See PageSetupDlgA.
  */
 BOOL WINAPI PageSetupDlgW(LPPAGESETUPDLGW setupdlg) {
     HGLOBAL		hDlgTmpl;
@@ -3483,6 +3487,11 @@
 
 /***********************************************************************
  *	PrintDlgExA (COMDLG32.@)
+ *
+ * See PrintDlgExW.
+ *
+ * FIXME
+ *   Stub
  */
 HRESULT WINAPI PrintDlgExA(LPPRINTDLGEXA lpPrintDlgExA)
 {
@@ -3492,6 +3501,25 @@
 
 /***********************************************************************
  *	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)
 {