Improve Doxygen documentation, deobfuscate event types

[vlc] / include / vlc / libvlc_events.h

diff --git a/include/vlc/libvlc_events.h b/include/vlc/libvlc_events.h
index afb4064b99c3d7dee2c072f400d262f7639a17fa..02278e4e097a3f65a6264637530086937fc54817 100644 (file)
--- a/include/vlc/libvlc_events.h
+++ b/include/vlc/libvlc_events.h
@@ -34,105 +34,85 @@
 extern "C" {
 # endif
 
-/*****************************************************************************
- * Events handling
- *****************************************************************************/
-
-/** \defgroup libvlc_event libvlc_event
- * \ingroup libvlc_core
- * LibVLC Available Events
+/**
+ * \ingroup libvlc_event
  * @{
  */
 
+/**
+ * Event types
+ */
+enum libvlc_event_e {
     /* Append new event types at the end. Do not remove, insert or
      * re-order any entry. The cpp will prepend libvlc_ to the symbols. */
-#define DEFINE_LIBVLC_EVENT_TYPES \
-    DEF( MediaMetaChanged ), \
-    DEF( MediaSubItemAdded ), \
-    DEF( MediaDurationChanged ), \
-    DEF( MediaPreparsedChanged ), \
-    DEF( MediaFreed ), \
-    DEF( MediaStateChanged ), \
-    \
-    DEF( MediaPlayerNothingSpecial ), \
-    DEF( MediaPlayerOpening ), \
-    DEF( MediaPlayerBuffering ), \
-    DEF( MediaPlayerPlaying ), \
-    DEF( MediaPlayerPaused ), \
-    DEF( MediaPlayerStopped ), \
-    DEF( MediaPlayerForward ), \
-    DEF( MediaPlayerBackward ), \
-    DEF( MediaPlayerEndReached ), \
-    DEF( MediaPlayerEncounteredError ), \
-    DEF( MediaPlayerTimeChanged ), \
-    DEF( MediaPlayerPositionChanged ), \
-    DEF( MediaPlayerSeekableChanged ), \
-    DEF( MediaPlayerPausableChanged ), \
-    \
-    DEF( MediaListItemAdded ), \
-    DEF( MediaListWillAddItem ), \
-    DEF( MediaListItemDeleted ), \
-    DEF( MediaListWillDeleteItem ), \
-    \
-    DEF( MediaListViewItemAdded ), \
-    DEF( MediaListViewWillAddItem ), \
-    DEF( MediaListViewItemDeleted ), \
-    DEF( MediaListViewWillDeleteItem ), \
-    \
-    DEF( MediaListPlayerPlayed ), \
-    DEF( MediaListPlayerNextItemSet ), \
-    DEF( MediaListPlayerStopped ), \
-    \
-    DEF( MediaDiscovererStarted ), \
-    DEF( MediaDiscovererEnded ), \
-    \
-    DEF( MediaPlayerTitleChanged ), \
-    DEF( MediaPlayerSnapshotTaken ), \
-    DEF( MediaPlayerLengthChanged ), \
-    \
-    DEF( VlmMediaAdded ), \
-    DEF( VlmMediaRemoved ), \
-    DEF( VlmMediaChanged ), \
-    DEF( VlmMediaInstanceStarted ), \
-    DEF( VlmMediaInstanceStopped ), \
-    DEF( VlmMediaInstanceStatusInit ), \
-    DEF( VlmMediaInstanceStatusOpening ), \
-    DEF( VlmMediaInstanceStatusPlaying ), \
-    DEF( VlmMediaInstanceStatusPause ), \
-    DEF( VlmMediaInstanceStatusEnd ), \
-    DEF( VlmMediaInstanceStatusError ), \
-    \
-    DEF( MediaPlayerMediaChanged ), \
-/* New event types HERE */
-
-#ifdef __cplusplus
-enum libvlc_event_type_e {
-#else
-enum libvlc_event_type_t {
-#endif
-#define DEF(a) libvlc_##a
-    DEFINE_LIBVLC_EVENT_TYPES
+    libvlc_MediaMetaChanged,
+    libvlc_MediaSubItemAdded,
+    libvlc_MediaDurationChanged,
+    libvlc_MediaPreparsedChanged,
+    libvlc_MediaFreed,
+    libvlc_MediaStateChanged,
+
+    libvlc_MediaPlayerNothingSpecial,
+    libvlc_MediaPlayerOpening,
+    libvlc_MediaPlayerBuffering,
+    libvlc_MediaPlayerPlaying,
+    libvlc_MediaPlayerPaused,
+    libvlc_MediaPlayerStopped,
+    libvlc_MediaPlayerForward,
+    libvlc_MediaPlayerBackward,
+    libvlc_MediaPlayerEndReached,
+    libvlc_MediaPlayerEncounteredError,
+    libvlc_MediaPlayerTimeChanged,
+    libvlc_MediaPlayerPositionChanged,
+    libvlc_MediaPlayerSeekableChanged,
+    libvlc_MediaPlayerPausableChanged,
+
+    libvlc_MediaListItemAdded,
+    libvlc_MediaListWillAddItem,
+    libvlc_MediaListItemDeleted,
+    libvlc_MediaListWillDeleteItem,
+
+    libvlc_MediaListViewItemAdded,
+    libvlc_MediaListViewWillAddItem,
+    libvlc_MediaListViewItemDeleted,
+    libvlc_MediaListViewWillDeleteItem,
+
+    libvlc_MediaListPlayerPlayed,
+    libvlc_MediaListPlayerNextItemSet,
+    libvlc_MediaListPlayerStopped,
+
+    libvlc_MediaDiscovererStarted,
+    libvlc_MediaDiscovererEnded,
+
+    libvlc_MediaPlayerTitleChanged,
+    libvlc_MediaPlayerSnapshotTaken,
+    libvlc_MediaPlayerLengthChanged,
+
+    libvlc_VlmMediaAdded,
+    libvlc_VlmMediaRemoved,
+    libvlc_VlmMediaChanged,
+    libvlc_VlmMediaInstanceStarted,
+    libvlc_VlmMediaInstanceStopped,
+    libvlc_VlmMediaInstanceStatusInit,
+    libvlc_VlmMediaInstanceStatusOpening,
+    libvlc_VlmMediaInstanceStatusPlaying,
+    libvlc_VlmMediaInstanceStatusPause,
+    libvlc_VlmMediaInstanceStatusEnd,
+    libvlc_VlmMediaInstanceStatusError,
+
+    libvlc_MediaPlayerMediaChanged,
+    /* New event types HERE */
     libvlc_num_event_types
-#undef  DEF
 };
 
-/* Implementing libvlc_event_type_name() needs the definition too. */
-#ifndef LIBVLC_EVENT_TYPES_KEEP_DEFINE
-#undef  DEFINE_LIBVLC_EVENT_TYPES
-#endif
-
 /**
- * An Event
- * \param type the even type
- * \param p_obj the sender object
- * \param u Event dependent content
+ * A LibVLC event
  */
-
-struct libvlc_event_t
+typedef struct libvlc_event_t
 {
-    libvlc_event_type_t type;
-    void * p_obj;
-    union event_type_specific
+    int   type; /**< Event type (see @ref libvlc_event_e) */
+    void *p_obj; /**< Object emitting the event */
+    union
     {
         /* media descriptor */
         struct
@@ -234,8 +214,8 @@ struct libvlc_event_t
         {
             libvlc_media_t * new_media;
         } media_player_media_changed;
-    } u;
-};
+    } u; /**< Type-dependent event description */
+} libvlc_event_t;
 
 
 /**@} */