uxtheme: improve c2man documentation
Markus Amsler
markus.amsler at oribi.org
Thu Nov 10 01:07:37 CST 2005
This patch improves the c2man Documented-Total count of uxtheme from
3(5%) to 9(15%).
Almost all functions from
http://www.winehq.org/pipermail/wine-devel/2005-November/041944.html are
now processed by c2man.
Changelog:
Markus Amsler <markus.amsler at oribi.org>
Improve c2man Documented-Total count. Changes:
- add missing returns section
-------------- next part --------------
Index: dlls/uxtheme/system.c
===================================================================
RCS file: /home/wine/wine/dlls/uxtheme/system.c,v
retrieving revision 1.26
diff -u -r1.26 system.c
--- dlls/uxtheme/system.c 6 Sep 2005 10:26:13 -0000 1.26
+++ dlls/uxtheme/system.c 10 Nov 2005 07:06:24 -0000
@@ -600,7 +600,13 @@
/***********************************************************************
* 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 @@
* 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 @@
*
* PARAMS
* hThemeFile Handle to theme file
+ *
+ * RETURNS
+ * Success: S_OK
+ * Failure: HRESULT error-code
*/
HRESULT WINAPI CloseThemeFile(HTHEMEFILE hThemeFile)
{
@@ -824,6 +838,10 @@
* 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 @@
* 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 @@
* 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 @@
*
* PARAMS
* pszIniFileName Path to a theme file
+ *
+ * RETURNS
+ * Success: S_OK
+ * Failure: HRESULT error-code
*/
HRESULT WINAPI CheckThemeSignature(LPCWSTR pszThemeFileName)
{
More information about the wine-patches
mailing list