For consistency, remove references to vlc from libvlc

[vlc] / include / main.h

diff --git a/include/main.h b/include/main.h
index 46a2cccd93665507d2b3256065a13e378f32b185..aa3919c52dd34646e3717da204f62e5d6e3a5238 100644 (file)
--- a/include/main.h
+++ b/include/main.h
@@ -23,42 +23,38 @@
  *****************************************************************************/
 
 /*****************************************************************************
- * libvlc_t (global variable)
+ * libvlc_global_data_t (global variable)
  *****************************************************************************
  * This structure has an unique instance, statically allocated in main and
- * never accessed from the outside. It store once-initialized data such as
+ * never accessed from the outside. It stores once-initialized data such as
  * the CPU capabilities or the global lock.
  *****************************************************************************/
-struct libvlc_t
+struct libvlc_global_data_t
 {
     VLC_COMMON_MEMBERS
 
-    /* Initialization boolean */
-    vlc_bool_t             b_ready;
-
-    /* CPU extensions */
-    uint32_t               i_cpu;
-
-    /* Generic settings */
-    int                    i_verbose;                       /* info messages */
-    vlc_bool_t             b_color;                       /* color messages? */
+    vlc_bool_t             b_ready;     ///< Initialization boolean
+    uint32_t               i_cpu;       ///< CPU extensions
+    
+    int                    i_verbose;   ///< info messages
+    vlc_bool_t             b_color;     ///< color messages?
 
     /* Object structure data */
-    int                    i_counter;                      /* object counter */
-    int                    i_objects;              /* Attached objects count */
-    vlc_object_t **        pp_objects;               /* Array of all objects */
+    int                    i_counter;   ///< object counter
+    int                    i_objects;   ///< Attached objects count
+    vlc_object_t **        pp_objects;  ///< Array of all objects 
+
+    msg_bank_t             msg_bank;    ///< The message bank
 
-    /* The message bank */
-    msg_bank_t             msg_bank;
+    module_bank_t *        p_module_bank; ///< The module bank
 
-    /* The module bank */
-    module_bank_t *        p_module_bank;
+    vlc_bool_t             b_stats;       ///< Should we collect stats
+    /* Timers handling */
+    vlc_mutex_t            timer_lock;    ///< Lock to protect timers
+    int                    i_timers;      ///< Number of timers
+    counter_t            **pp_timers;     ///< Array of all timers
 
-    /* Do stats ? - We keep this boolean to avoid unneeded lookups */
-    vlc_bool_t             b_stats;
-    vlc_mutex_t            timer_lock;
-    int                    i_timers;
-    counter_t            **pp_timers;
+    intf_thread_t         *p_probe;       ///< Devices prober
 
     /* Arch-specific variables */
 #if !defined( WIN32 )
@@ -82,11 +78,11 @@ struct libvlc_t
 };
 
 /*****************************************************************************
- * vlc_t, p_vlc
+ * libvlc_internal_instance_t
  *****************************************************************************
- * This structure is a LibVLC instance.
+ * This structure is a LibVLC instance, for use by libvlc core and plugins
  *****************************************************************************/
-struct vlc_t
+struct libvlc_int_t
 {
     VLC_COMMON_MEMBERS