[ros-diffs] [gbrunmar] 35564: Added missing documentation

[gbrunmar at svn.reactos.org]

Author: gbrunmar
Date: Sat Aug 23 10:17:00 2008
New Revision: 35564

URL: http://svn.reactos.org/svn/reactos?rev=35564&view=rev
Log:
Added missing documentation

Modified:
    trunk/reactos/dll/directx/d3d9/d3d9_baseobject.c
    trunk/reactos/dll/directx/d3d9/d3d9_baseobject.h
    trunk/reactos/dll/directx/d3d9/d3d9_impl.c
    trunk/reactos/dll/directx/d3d9/d3d9_swapchain.c
    trunk/reactos/dll/directx/d3d9/d3d9_swapchain.h

Modified: trunk/reactos/dll/directx/d3d9/d3d9_baseobject.c
URL: http://svn.reactos.org/svn/reactos/trunk/reactos/dll/directx/d3d9/d3d9_baseobject.c?rev=35564&r1=35563&r2=35564&view=diff
==============================================================================
--- trunk/reactos/dll/directx/d3d9/d3d9_baseobject.c [iso-8859-1] (original)
+++ trunk/reactos/dll/directx/d3d9/d3d9_baseobject.c [iso-8859-1] Sat Aug 23 10:17:00 2008
@@ -1,3 +1,10 @@
+/*
+ * COPYRIGHT:       See COPYING in the top level directory
+ * PROJECT:         ReactOS ReactX
+ * FILE:            dll/directx/d3d9/d3d9_baseobject.c
+ * PURPOSE:         Direct3D9's base object
+ * PROGRAMERS:      Gregor Gullwi <gbrunmar (dot) ros (at) gmail (dot) com>
+ */
 #include "d3d9_baseobject.h"
 #include "d3d9_device.h"
 

Modified: trunk/reactos/dll/directx/d3d9/d3d9_baseobject.h
URL: http://svn.reactos.org/svn/reactos/trunk/reactos/dll/directx/d3d9/d3d9_baseobject.h?rev=35564&r1=35563&r2=35564&view=diff
==============================================================================
--- trunk/reactos/dll/directx/d3d9/d3d9_baseobject.h [iso-8859-1] (original)
+++ trunk/reactos/dll/directx/d3d9/d3d9_baseobject.h [iso-8859-1] Sat Aug 23 10:17:00 2008
@@ -1,3 +1,10 @@
+/*
+ * COPYRIGHT:       See COPYING in the top level directory
+ * PROJECT:         ReactOS ReactX
+ * FILE:            dll/directx/d3d9/d3d9_baseobject.h
+ * PURPOSE:         Direct3D9's base object
+ * PROGRAMERS:      Gregor Gullwi <gbrunmar (dot) ros (at) gmail (dot) com>
+ */
 #ifndef _D3D9_BASEOBJECT_H_
 #define _D3D9_BASEOBJECT_H_
 

Modified: trunk/reactos/dll/directx/d3d9/d3d9_impl.c
URL: http://svn.reactos.org/svn/reactos/trunk/reactos/dll/directx/d3d9/d3d9_impl.c?rev=35564&r1=35563&r2=35564&view=diff
==============================================================================
--- trunk/reactos/dll/directx/d3d9/d3d9_impl.c [iso-8859-1] (original)
+++ trunk/reactos/dll/directx/d3d9/d3d9_impl.c [iso-8859-1] Sat Aug 23 10:17:00 2008
@@ -889,6 +889,46 @@
     return hAdapterMonitor;
 }
 
+/*++
+* @name IDirect3D9::CreateDevice
+* @implemented
+*
+* The function IDirect3D9Impl_CreateDevice creates an IDirect3DDevice9 object
+* that represents the display adapter.
+*
+* @param LPDIRECT3D iface
+* Pointer to the IDirect3D9 object returned from Direct3DCreate9()
+*
+* @param UINT Adapter
+* Adapter index to get information about. D3DADAPTER_DEFAULT is the primary display.
+* The maximum value for this is the value returned by IDirect3D::GetAdapterCount() - 1.
+*
+* @param D3DDEVTYPE DeviceType
+* One of the D3DDEVTYPE enum members.
+*
+* @param HWND hFocusWindow
+* A window handle that is used as a reference when Direct3D should switch between
+* foreground mode and background mode.
+*
+* @param DWORD BehaviourFlags
+* Any valid combination of the D3DCREATE constants.
+*
+* @param D3DPRESENT_PARAMETERS* pPresentationParameters
+* Pointer to a D3DPRESENT_PARAMETERS structure describing the parameters for the device
+* to be created. If D3DCREATE_ADAPTERGROUP_DEVICE is specified in the BehaviourFlags parameter,
+* the pPresentationParameters is treated as an array.
+*
+* @param IDirect3DDevice9** ppReturnedDeviceInterface
+* Return object that represents the created device.
+*
+* @return HRESULT
+* If the method successfully creates a device and returns a valid ppReturnedDeviceInterface object,
+* the return value is D3D_OK.
+* If Adapter is out of range, DeviceType is invalid, hFocusWindow is not a valid, BehaviourFlags is invalid
+* pPresentationParameters is invalid or ppReturnedDeviceInterface is a bad pointer, the return value
+* will be D3DERR_INVALIDCALL.
+*
+*/
 static HRESULT WINAPI IDirect3D9Impl_CreateDevice(LPDIRECT3D9 iface, UINT Adapter, D3DDEVTYPE DeviceType,
                                                   HWND hFocusWindow, DWORD BehaviourFlags,
                                                   D3DPRESENT_PARAMETERS* pPresentationParameters,

Modified: trunk/reactos/dll/directx/d3d9/d3d9_swapchain.c
URL: http://svn.reactos.org/svn/reactos/trunk/reactos/dll/directx/d3d9/d3d9_swapchain.c?rev=35564&r1=35563&r2=35564&view=diff
==============================================================================
--- trunk/reactos/dll/directx/d3d9/d3d9_swapchain.c [iso-8859-1] (original)
+++ trunk/reactos/dll/directx/d3d9/d3d9_swapchain.c [iso-8859-1] Sat Aug 23 10:17:00 2008
@@ -1,3 +1,10 @@
+/*
+ * COPYRIGHT:       See COPYING in the top level directory
+ * PROJECT:         ReactOS ReactX
+ * FILE:            dll/directx/d3d9/d3d9_swapchain.c
+ * PURPOSE:         Direct3D9's swap chain object
+ * PROGRAMERS:      Gregor Gullwi <gbrunmar (dot) ros (at) gmail (dot) com>
+ */
 #include "d3d9_swapchain.h"
 
 #include <debug.h>

Modified: trunk/reactos/dll/directx/d3d9/d3d9_swapchain.h
URL: http://svn.reactos.org/svn/reactos/trunk/reactos/dll/directx/d3d9/d3d9_swapchain.h?rev=35564&r1=35563&r2=35564&view=diff
==============================================================================
--- trunk/reactos/dll/directx/d3d9/d3d9_swapchain.h [iso-8859-1] (original)
+++ trunk/reactos/dll/directx/d3d9/d3d9_swapchain.h [iso-8859-1] Sat Aug 23 10:17:00 2008
@@ -1,3 +1,10 @@
+/*
+ * COPYRIGHT:       See COPYING in the top level directory
+ * PROJECT:         ReactOS ReactX
+ * FILE:            dll/directx/d3d9/d3d9_swapchain.h
+ * PURPOSE:         Direct3D9's swap chain object
+ * PROGRAMERS:      Gregor Gullwi <gbrunmar (dot) ros (at) gmail (dot) com>
+ */
 #ifndef _D3D9_SWAPCHAIN_H_
 #define _D3D9_SWAPCHAIN_H_