[ros-diffs] [greatlrd] 31537: adding documentations for DxEngGetDCState

Author: greatlrd
Date: Tue Jan  1 22:15:22 2008
New Revision: 31537

URL: http://svn.reactos.org/svn/reactos?rev=31537&view=rev
Log:
adding documentations for DxEngGetDCState

Modified:
    trunk/reactos/subsystems/win32/win32k/ntddraw/dxeng.c

Modified: trunk/reactos/subsystems/win32/win32k/ntddraw/dxeng.c
URL: http://svn.reactos.org/svn/reactos/trunk/reactos/subsystems/win32/win32k/ntd...
==============================================================================
--- trunk/reactos/subsystems/win32/win32k/ntddraw/dxeng.c (original)
+++ trunk/reactos/subsystems/win32/win32k/ntddraw/dxeng.c Tue Jan  1 22:15:22 2008
@@ -399,14 +399,31 @@
     return FALSE;
 }

-/************************************************************************/
-/* DxEngGetDCState                                                      */
-/************************************************************************/
-/* Note type 0 = N/A */
-/* Note type 1 = Is DC full screen */
-/* Note type 2 = Get Complexity of visiable region. */
-/* Note type 3 = Get Driver hdev, which is pPDev. */
-
+
+
+/*++
+* @name DxEngGetDCState
+* @implemented
+*
+* The function DxEngGetDCState getting sate 
+* if it DC full screen /  Get Complexity of visiable region or
+* Get Driver hdev, which is pPDev
+*
+* @param HDC hdc
+* The hdc
+*
+* @param DWORD type
+* value 1 = Is DC full screen 
+* value 2 = Get Complexity of visiable region. 
+* value 3 = Get Driver hdev, which is pPDev. 
+*
+* @return
+* return one of the type value 
+*
+* @remarks.
+* we do not have type 2 implement yet
+*
+*--*/
 DWORD
 DxEngGetDCState(HDC hDC,
                 DWORD type)
@@ -425,12 +442,14 @@
                 UNIMPLEMENTED;
                 break;
             case 3:
-            {   // Return HDEV of this DC.            
+            {
+                /* Return HDEV of this DC. */            
                 retVal = (DWORD) pDC->pPDev;
                 break;
             }
             default:
-                UNIMPLEMENTED;
+                /* if it does not found a type it wanted we return 0 as value */
+                DPRINT1("warning did not found type %d\n",type); 
                 break;
         }
         DC_UnlockDc(pDC);