wine/dlls/uxtheme system.c

[Alexandre Julliard]

ChangeSet ID:	21203
CVSROOT:	/opt/cvs-commit
Module name:	wine
Changes by:	[e-mail]	2005/11/10 05:05:45

Modified files:
    dlls/uxtheme   : system.c

Log message:
    Markus Amsler 
    Improve c2man Documented-Total count. Changes:
    - add missing returns section

Patch: http://cvs.winehq.org/patch.py?id=21203

Old revision  New revision  Changes     Path
 1.26          1.27          +31 -1      wine/dlls/uxtheme/system.c

Index: wine/dlls/uxtheme/system.c
diff -u -p wine/dlls/uxtheme/system.c:1.26 wine/dlls/uxtheme/system.c:1.27
--- wine/dlls/uxtheme/system.c:1.26	10 Nov 2005 11: 5:45 -0000
+++ wine/dlls/uxtheme/system.c	10 Nov 2005 11: 5:45 -0000
@@ -600,7 +600,13 @@ HTHEME WINAPI OpenThemeData(HWND hwnd, L
 /***********************************************************************
  *      GetWindowTheme                                      (UXTHEME.@)
  *
- * Retrieve the last theme opened for a window
+ * Retrieve the last theme opened for a window.
+ *
+ * PARAMS
+ *  hwnd  [I] window to retrieve the theme for
+ *
+ * RETURNS
+ *  The most recent theme.
  */
 HTHEME WINAPI GetWindowTheme(HWND hwnd)
 {
@@ -788,6 +794,10 @@ DWORD WINAPI QueryThemeServices()
  *     pszColorName        Color defined in the theme, eg. NormalColor
  *     pszSizeName         Size defined in the theme, eg. NormalSize
  *     hThemeFile          Handle to theme file
+ *
+ * RETURNS
+ *     Success: S_OK
+ *     Failure: HRESULT error-code
  */
 HRESULT WINAPI OpenThemeFile(LPCWSTR pszThemeFileName, LPCWSTR pszColorName,
                              LPCWSTR pszSizeName, HTHEMEFILE *hThemeFile,
@@ -806,6 +816,10 @@ HRESULT WINAPI OpenThemeFile(LPCWSTR psz
  *
  * PARAMS
  *     hThemeFile           Handle to theme file
+ *
+ * RETURNS
+ *     Success: S_OK
+ *     Failure: HRESULT error-code
  */
 HRESULT WINAPI CloseThemeFile(HTHEMEFILE hThemeFile)
 {
@@ -824,6 +838,10 @@ HRESULT WINAPI CloseThemeFile(HTHEMEFILE
  *     unknown              See notes
  *     hWnd                 Window requesting the theme change
  *
+ * RETURNS
+ *     Success: S_OK
+ *     Failure: HRESULT error-code
+ *
  * NOTES
  * I'm not sure what the second parameter is (the datatype is likely wrong), other then this:
  * Under XP if I pass
@@ -854,6 +872,10 @@ HRESULT WINAPI ApplyTheme(HTHEMEFILE hTh
  *     dwColorNameLen      Length, in characters, of color name buffer
  *     pszSizeName         Buffer to receive the default size name
  *     dwSizeNameLen       Length, in characters, of size name buffer
+ *
+ * RETURNS
+ *     Success: S_OK
+ *     Failure: HRESULT error-code
  */
 HRESULT WINAPI GetThemeDefaults(LPCWSTR pszThemeFileName, LPWSTR pszColorName,
                                 DWORD dwColorNameLen, LPWSTR pszSizeName,
@@ -885,6 +907,10 @@ HRESULT WINAPI GetThemeDefaults(LPCWSTR 
  *     pszThemePath        Path containing themes
  *     callback            Called for each theme found in path
  *     lpData              Passed through to callback
+ *
+ * RETURNS
+ *     Success: S_OK
+ *     Failure: HRESULT error-code
  */
 HRESULT WINAPI EnumThemes(LPCWSTR pszThemePath, EnumThemeProc callback,
                           LPVOID lpData)
@@ -1097,6 +1123,10 @@ HRESULT WINAPI ParseThemeIniFile(LPCWSTR
  *
  * PARAMS
  *     pszIniFileName      Path to a theme file
+ *
+ * RETURNS
+ *     Success: S_OK
+ *     Failure: HRESULT error-code
  */
 HRESULT WINAPI CheckThemeSignature(LPCWSTR pszThemeFileName)
 {