diff dvdnav_events.h @ 43:0ba15bf3dc25 src

Biiiiiiig change to let doxygen generate some docs for the library. Note that I'm in no way sure that the autoconf stuff plays nice.

--- a/dvdnav_events.h	Tue Jun 04 13:35:16 2002 +0000
+++ b/dvdnav_events.h	Thu Jun 06 15:03:09 2002 +0000
@@ -28,65 +28,87 @@
 #include <dvdread/nav_types.h>
 #include <dvdread/dvd_reader.h>
 
-/* This header defines events and event types */
+/**
+ * \file dvdnav_events.h
+ * This header defines events and event types 
+ */
 
 /*** EVENTS ***/
 
-#define DVDNAV_BLOCK_OK     0 /* The next black was returned */
-#define DVDNAV_NOP          1 /* No action should be taken   */
-#define DVDNAV_STILL_FRAME  2 /* The preceeding block was the last in a 
+#define DVDNAV_BLOCK_OK     0 /*!< The next black was returned */
+#define DVDNAV_NOP          1 /*!< No action should be taken   */
+#define DVDNAV_STILL_FRAME  2 /*!< The preceeding block was the last in a 
 				 still frame. */
-#define DVDNAV_SPU_STREAM_CHANGE    3 /* The SPU stream was changed */
-#define DVDNAV_AUDIO_STREAM_CHANGE  4 /* The Audio stream was changed */
-#define DVDNAV_VTS_CHANGE   5 /* We have changed VTS */ 
-#define DVDNAV_CELL_CHANGE  6 /* We have jumped to a new cell */
-#define DVDNAV_NAV_PACKET   7 /* The packet just passed was the NAV packet */
-#define DVDNAV_STOP         8 /* The last block was final, no more are coming */
-#define DVDNAV_HIGHLIGHT    9 /* Change highlight region */
-#define DVDNAV_SPU_CLUT_CHANGE 10 /* SPU CLUT */
-#define DVDNAV_SEEK_DONE    11 /* Seek done, subtitles should be reset */
-#define DVDNAV_HOP_CHANNEL  12 /* Sent when non-seemless stream change has happed */
-                               /* E.g. Menu button pressed causing change in menu */
+#define DVDNAV_SPU_STREAM_CHANGE    3 /*!< The SPU stream was changed */
+#define DVDNAV_AUDIO_STREAM_CHANGE  4 /*!< The Audio stream was changed */
+#define DVDNAV_VTS_CHANGE   5 /*!< We have changed VTS */ 
+#define DVDNAV_CELL_CHANGE  6 /*!< We have jumped to a new cell */
+#define DVDNAV_NAV_PACKET   7 /*!< The packet just passed was the NAV packet */
+#define DVDNAV_STOP         8 /*!< The last block was final, no more are coming */
+#define DVDNAV_HIGHLIGHT    9 /*!< Change highlight region */
+#define DVDNAV_SPU_CLUT_CHANGE 10 /*!< SPU CLUT */
+#define DVDNAV_SEEK_DONE    11 /*!< Seek done, subtitles should be reset */
+#define DVDNAV_HOP_CHANNEL  12 /*!< Sent when non-seemless stream change has happed 
+                                E.g. Menu button pressed causing change in menu */
 
 /*** EVENT TYPES ***/
 
+/**
+ * Structure providing information on DVDNAV_STILL_FRAME events.
+ */
 typedef struct {
-  int length;   /* The length (in seconds) the still frame
-		 * should be displayed for, or 0xff if
-		 * indefinate. */
+  int length;   /*!<
+		  The length (in seconds) the still frame
+		  should be displayed for, or 0xff if
+		  indefinate. */
 } dvdnav_still_event_t;
 
+/**
+ * Structure providing information on DVDNAV_*_STREAM_CHANGE events.
+ */
 typedef struct {
-  int physical; /* The physical (MPEG) stream number. */
-  int logical;  /* The logical (DVD) stream number.   */
+  int physical; /*!< The physical (MPEG) stream number. */
+  int logical;  /*!< The logical (DVD) stream number.   */
 } dvdnav_stream_change_event_t;
 
+/**
+ * Structure providing information on DVDNAV_VTS_CHANGE events.
+ */
 typedef struct {
-  int old_vtsN; /* The old VTS number */
-  dvd_read_domain_t old_domain; /* The old domain */
-  int new_vtsN; /* The new one */
-  dvd_read_domain_t new_domain;
+  int old_vtsN; /*!< The old VTS number */
+  dvd_read_domain_t old_domain; /*!< The old domain */
+  int new_vtsN; /*!< The new VTS number */
+  dvd_read_domain_t new_domain; /*!< The new domain */
 } dvdnav_vts_change_event_t;
 
+/**
+ * Structure providing information on DVDNAV_CELL_CHANGE events.
+ */
 typedef struct {
-  cell_playback_t *old_cell; /* The old cell (or NULL if this is 
+  cell_playback_t *old_cell; /*!< The old cell (or NULL if this is 
 				the first cell) */
-  cell_playback_t *new_cell; /* The cell_playback_t for the new cell */
+  cell_playback_t *new_cell; /*!< The cell_playback_t for the new cell */
 } dvdnav_cell_change_event_t;
 
+/**
+ * Structure providing information on DVDNAV_NAV_PACKET events.
+ */
 typedef struct {
   pci_t *pci;
   dsi_t *dsi;
 } dvdnav_nav_packet_event_t;
 
+/**
+ * Structure providing information on DVDNAV_HIGHLIGHT events.
+ */
 typedef struct {
-  int display; /* 0 - hide, 1 - show, entries below only guaranteed useful
+  int display; /*!< 0 - hide, 1 - show, entries below only guaranteed useful
 		  if this is '1' */
-  uint32_t palette;  /* The CLUT entries for the highlight palette 
+  uint32_t palette;  /*!< The CLUT entries for the highlight palette 
                         (4-bits per entry -> 4 entries) */
-  uint16_t sx,sy,ex,ey; /* The start/end x,y positions */
-  uint32_t pts;         /* Highlight PTS to match with SPU */
-  uint32_t buttonN;     /* Button number for the SPU decoder. */
+  uint16_t sx,sy,ex,ey; /*!< The start/end x,y positions */
+  uint32_t pts;         /*!< Highlight PTS to match with SPU */
+  uint32_t buttonN;     /*!< Button number for the SPU decoder. */
 } dvdnav_highlight_event_t;
 
 #endif /* DVDNAV_EVENTS_H_INCLUDED */