Completion of editing current documentation in dxg
authorZiliang Guo <drakekaizer666@gmail.com>
Wed, 2 Jan 2008 05:44:59 +0000 (05:44 +0000)
committerZiliang Guo <drakekaizer666@gmail.com>
Wed, 2 Jan 2008 05:44:59 +0000 (05:44 +0000)
svn path=/trunk/; revision=31553

reactos/drivers/directx/dxg/ddhmg.c
reactos/drivers/directx/dxg/historic.c

index d277a60..2eee7be 100644 (file)
@@ -35,14 +35,14 @@ VerifyObjectOwner(PDD_ENTRY pEntry)
 * @name DdHmgCreate
 * @implemented
 *
 * @name DdHmgCreate
 * @implemented
 *
-* The function DdHmgCreate is internal use in dxg.sys
-* It Create all DX kernel object that is need it, for create DX object.
+* The function DdHmgCreate is used internally in dxg.sys
+* It creates all DX kernel objects that are need it for creation of DX objects.
 *
 * @return
 *
 * @return
-* return FALSE for fail, return TRUE for sussess create DX object
+* Return FALSE for failure and TRUE for success in creating the DX object
 *
 * @remarks.
 *
 * @remarks.
-* Only use internal in dxg.sys
+* Only used internally in dxg.sys
 *--*/
 BOOL
 FASTCALL
 *--*/
 BOOL
 FASTCALL
@@ -81,14 +81,14 @@ DdHmgCreate()
 * @name DdHmgDestroy
 * @implemented
 *
 * @name DdHmgDestroy
 * @implemented
 *
-* The function DdHmgDestroy is internal use in dxg.sys
-* It destore all DX kernel object
+* The function DdHmgDestroy is used internally in dxg.sys
+* It destroys all DX kernel objects
 *
 * @return
 *
 * @return
-* return FALSE for fail or noting to destore, return TRUE for sussess destore all dx object
+* Always returns true, as a failure here would result in a BSOD.
 *
 * @remarks.
 *
 * @remarks.
-* Only use internal in dxg.sys
+* Only used internally in dxg.sys
 *--*/
 BOOL
 FASTCALL
 *--*/
 BOOL
 FASTCALL
@@ -118,29 +118,29 @@ DdHmgDestroy()
 * @name DdHmgLock
 * @implemented
 *
 * @name DdHmgLock
 * @implemented
 *
-* The function DdHmgLock is internal use in dxg.sys
-* it lock a Dx kernel object
+* The function DdHmgLock is used internally in dxg.sys
+* It locks a DX kernel object
 *
 * @param HANDLE DdHandle
 *
 * @param HANDLE DdHandle
-* The handle we want lock
+* The handle we want locked
 *
 * @param UCHAR ObjectType
 *
 * @param UCHAR ObjectType
-* The type of the object we expected the handle contain
-* value 0 is for getting ?
-* value 1 is for getting EDD_DIRECTDRAW_LOCAL
-* value 2 is for getting EDD_SURFACE
-* value 3 is for getting ?
-* value 4 is for getting EDD_VIDEOPORT
-* value 5 is for getting EDD_MOTIONCOMP
+* The type of the object we expected the handle to contain
+* value 0 is for ?
+* value 1 is for EDD_DIRECTDRAW_LOCAL
+* value 2 is for EDD_SURFACE
+* value 3 is for ?
+* value 4 is for EDD_VIDEOPORT
+* value 5 is for EDD_MOTIONCOMP
 
 * @param BOOLEAN LockOwned
 
 * @param BOOLEAN LockOwned
-* if it need be EngAcquireSemaphore or not
+* If it needs to call EngAcquireSemaphore or not
 *
 * @return
 *
 * @return
-* return a EDD_* object, or NULL depnes if it success or not.
+* Returns an EDD_* object, or NULL if it fails
 *
 * @remarks.
 *
 * @remarks.
-* Only use internal in dxg.sys
+* Only used internally in dxg.sys
 *--*/
 PVOID
 FASTCALL
 *--*/
 PVOID
 FASTCALL
index f69e1e8..2b30f85 100644 (file)
@@ -15,7 +15,7 @@
 * @name DxDxgGenericThunk
 * @implemented
 *
 * @name DxDxgGenericThunk
 * @implemented
 *
-* The function DxDxgGenericThunk redirect dx call to other thing.
+* The function DxDxgGenericThunk redirects DirectX calls to other functions.
 *
 * @param ULONG_PTR ulIndex
 * The functions we want redirct
 *
 * @param ULONG_PTR ulIndex
 * The functions we want redirct
 * Unknown
 *
 * @return 
 * Unknown
 *
 * @return 
-* always return DDHAL_DRIVER_NOTHANDLED
+* Always returns DDHAL_DRIVER_NOTHANDLED
 *
 * @remarks.
 *
 * @remarks.
-* This api are not longer use in Windows NT 2000/XP/2003
+* This function is no longer used in Windows NT 2000/XP/2003
 *
 *--*/
 DWORD
 *
 *--*/
 DWORD
@@ -59,7 +59,7 @@ DxDxgGenericThunk(ULONG_PTR ulIndex,
 * @name DxDdIoctl
 * @implemented
 *
 * @name DxDdIoctl
 * @implemented
 *
-* The function DxDdIoctl is the ioctl call to diffent dx functions 
+* The function DxDdIoctl is the ioctl call to diffent DirectX functions 
 *
 * @param ULONG ulIoctl
 * The ioctl code that we want call to
 *
 * @param ULONG ulIoctl
 * The ioctl code that we want call to
@@ -71,10 +71,10 @@ DxDxgGenericThunk(ULONG_PTR ulIndex,
 * The buffer size in bytes
 *
 * @return 
 * The buffer size in bytes
 *
 * @return 
-* always return DDERR_UNSUPPORTED
+* Always returns DDERR_UNSUPPORTED
 *
 * @remarks.
 *
 * @remarks.
-* This api are not longer use in Windows NT 2000/XP/2003
+* This function is no longer used in Windows NT 2000/XP/2003
 *
 *--*/
 DWORD
 *
 *--*/
 DWORD