From 827e4de5670d327f0379a80fdf2348c1e38f5434 Mon Sep 17 00:00:00 2001
From: John Hodge <tpg@prelude.mutabah.net>
Date: Sat, 24 Apr 2010 23:47:19 +0800
Subject: [PATCH] Fixing documentation for 2D operations

---
 Kernel/Makefile.BuildNum       |  2 +-
 Kernel/include/tpl_drv_video.h | 37 +++++++++++++++++++++++++++++++---
 2 files changed, 35 insertions(+), 4 deletions(-)

diff --git a/Kernel/Makefile.BuildNum b/Kernel/Makefile.BuildNum
index 8a76d62b..306f0f32 100644
--- a/Kernel/Makefile.BuildNum
+++ b/Kernel/Makefile.BuildNum
@@ -1 +1 @@
-BUILD_NUM = 2071
+BUILD_NUM = 2072
diff --git a/Kernel/include/tpl_drv_video.h b/Kernel/include/tpl_drv_video.h
index 89bdbfd8..f3313f62 100644
--- a/Kernel/include/tpl_drv_video.h
+++ b/Kernel/include/tpl_drv_video.h
@@ -160,7 +160,9 @@ enum eTplVideo_BufFormats
 };
 
 /**
- * \brief 
+ * \brief 2D Accellerated Video Commands
+ * 
+ * Commands passed in the command stream for ::VIDEO_BUFFMT_2DSTREAM
  */
 enum eTplVideo_2DCommands
 {
@@ -254,17 +256,46 @@ extern void	VT_Font_Render(Uint32 Codepoint, void *Buffer, int Pitch, Uint32 BGC
 extern Uint32	VT_Colour12to24(Uint16 Col12);
 
 /**
- * 
+ * \brief Handlers for eTplVideo_2DCommands
  */
 typedef struct sDrvUtil_Video_2DHandlers
 {
+	/**
+	 * \brief No Operation, Ignored
+	 * \see VIDEO_2DOP_NOP
+	 */
 	void	*Nop;
+	/**
+	 * \brief Fill a buffer region
+	 * \param X	Lefthand edge
+	 * \param Y	Top edge
+	 * \param W	Width
+	 * \param H	Height
+	 * \param Colour	Colour to fill with
+	 * \see VIDEO_2DOP_FILL
+	 */
 	void	(*Fill)(void *Ent, Uint16 X, Uint16 Y, Uint16 W, Uint16 H, Uint32 Colour);
+	/**
+	 * \brief Fill a buffer region
+	 * \param DestX	Lefthand edge of destination
+	 * \param DestY	Top edge of destination
+	 * \param SrcX	Lefthand edge of source
+	 * \param SrcY	Top edge of source
+	 * \param W	Width
+	 * \param H	Height
+	 * \see VIDEO_2DOP_BLIT
+	 */
 	void	(*Blit)(void *Ent, Uint16 DestX, Uint16 DestY, Uint16 SrcX, Uint16 SrcY, Uint16 W, Uint16 H);
 }	tDrvUtil_Video_2DHandlers;
 
 /**
- * \brief 
+ * \brief Handle a 2D operation stream for a driver
+ * \param Ent	Value to pass to handlers
+ * \param Buffer	Stream buffer
+ * \param Length	Length of stream
+ * \param Handlers	Handlers to use for the stream
+ * \param SizeofHandlers	Size of \a tDrvUtil_Video_2DHandlers according
+ *        to the driver. Used as version control and error avoidence.
  */
 extern Uint64	DrvUtil_Video_2DStream(void *Ent, void *Buffer, int Length,
 	tDrvUtil_Video_2DHandlers *Handlers, int SizeofHandlers);
-- 
2.20.1