Kernel - Doxygen fixes

[tpg/acess2.git] / Kernel / include / api_drv_video.h

diff --git a/Kernel/include/api_drv_video.h b/Kernel/include/api_drv_video.h
index 8419db2..b1abe59 100644 (file)
--- a/Kernel/include/api_drv_video.h
+++ b/Kernel/include/api_drv_video.h
@@ -98,7 +98,11 @@ enum eTplVideo_IOCtl {
         */\r
        VIDEO_IOCTL_SETCURSORBITMAP\r
 };\r
-#define DRV_VIDEO_IOCTLNAMES   "getset_mode", "find+mode", "mode_info", "set_buf_format", "set_cursor", "set_cursor_bitmap"\r
+\r
+/**\r
+ * \brief Symbolic names for Video IOCtls (#4 onwards)\r
+ */\r
+#define DRV_VIDEO_IOCTLNAMES   "getset_mode", "find_mode", "mode_info", "set_buf_format", "set_cursor", "set_cursor_bitmap"\r
 \r
 /**\r
  * \brief Mode Structure used in IOCtl Calls\r
@@ -251,6 +255,10 @@ typedef struct sVT_Char
 extern int     giVT_CharWidth;\r
 //! \brief Defines the height of a rendered character\r
 extern int     giVT_CharHeight;\r
+/**\r
+ * \name Font rendering\r
+ * \{\r
+ */\r
 /**\r
  * \brief Driver helper that renders a character to a buffer\r
  * \param Codepoint    Unicode character to render\r
@@ -291,9 +299,9 @@ extern Uint16       VT_Colour12to15(Uint16 Col12);
  * The final bit of each component is used to fill the lower bits of the output.\r
  */\r
 extern Uint32  VT_Colour12toN(Uint16 Col12, int Depth);\r
-\r
-typedef struct sDrvUtil_Video_BufInfo  tDrvUtil_Video_BufInfo;\r
-typedef struct sDrvUtil_Video_2DHandlers       tDrvUtil_Video_2DHandlers;\r
+/**\r
+ * \}\r
+ */\r
 \r
 /**\r
  * \brief Maximum cursor width for using the DrvUtil software cursor\r
@@ -307,7 +315,7 @@ typedef struct sDrvUtil_Video_2DHandlers    tDrvUtil_Video_2DHandlers;
 /**\r
  * \brief Framebuffer information used by all DrvUtil_Video functions\r
  */\r
-struct sDrvUtil_Video_BufInfo\r
+typedef struct sDrvUtil_Video_BufInfo\r
 {\r
        /**\r
         * \brief Framebuffer virtual address\r
@@ -331,7 +339,7 @@ struct sDrvUtil_Video_BufInfo
         int    Depth;\r
        \r
        /**\r
-        * \brief Software cursor controls\r
+        * \name Software cursor controls\r
         * \{\r
         */\r
        /**\r
@@ -355,12 +363,12 @@ struct sDrvUtil_Video_BufInfo
        /*\r
         * \}\r
         */\r
-};\r
+} tDrvUtil_Video_BufInfo;\r
 \r
 /**\r
  * \brief Handlers for eTplVideo_2DCommands\r
  */\r
-struct sDrvUtil_Video_2DHandlers\r
+typedef struct sDrvUtil_Video_2DHandlers\r
 {\r
        /**\r
         * \brief No Operation, Ignored\r
@@ -388,7 +396,7 @@ struct sDrvUtil_Video_2DHandlers
         * \see VIDEO_2DOP_BLIT\r
         */\r
        void    (*Blit)(void *Ent, Uint16 DestX, Uint16 DestY, Uint16 SrcX, Uint16 SrcY, Uint16 W, Uint16 H);\r
-};\r
+} tDrvUtil_Video_2DHandlers;\r
 \r
 /**\r
  * \brief Handle a 2D operation stream for a driver\r
@@ -417,7 +425,7 @@ extern int  DrvUtil_Video_2DStream(void *Ent, void *Buffer, int Length,
 extern int     DrvUtil_Video_WriteLFB(int Mode, tDrvUtil_Video_BufInfo *FBInfo, size_t Offset, size_t Length, void *Src);\r
 \r
 /**\r
- * \brief Software cursor rendering\r
+ * \name Software cursor rendering\r
  * \{\r
  */\r
 /**\r