From: Rémi Denis-Courmont <rem@videolan.org>
Date: Sun, 4 May 2008 16:48:59 +0000 (+0300)
Subject: libvlc_global_data_t: fix description
X-Git-Tag: 0.9.0-test0~1180
X-Git-Url: https://git.sesse.net/?a=commitdiff_plain;h=aebd6a4333c175bd5cd00ced4b25586be74c3837;p=vlc

libvlc_global_data_t: fix description
---

diff --git a/include/vlc_common.h b/include/vlc_common.h
index c10df6628b..1fdb7e27ce 100644
--- a/include/vlc_common.h
+++ b/include/vlc_common.h
@@ -122,7 +122,6 @@ static inline void __vlc_fourcc_to_char( vlc_fourcc_t fcc, char *psz_fourcc )
  *****************************************************************************/
 
 /* Internal types */
-typedef struct libvlc_global_data_t libvlc_global_data_t;
 typedef struct libvlc_int_t libvlc_int_t;
 typedef struct variable_t variable_t;
 typedef struct date_t date_t;
diff --git a/src/libvlc.h b/src/libvlc.h
index 6a31ff6843..16ad761168 100644
--- a/src/libvlc.h
+++ b/src/libvlc.h
@@ -98,14 +98,14 @@ extern void *
 vlc_custom_create (vlc_object_t *p_this, size_t i_size, int i_type,
                    const char *psz_type);
 
-/*****************************************************************************
+/**
  * libvlc_global_data_t (global variable)
- *****************************************************************************
- * This structure has an unique instance, statically allocated in main and
- * never accessed from the outside. It stores once-initialized data such as
- * the CPU capabilities or the global lock.
- *****************************************************************************/
-struct libvlc_global_data_t
+ *
+ * This structure has an unique instance, statically allocated in libvlc and
+ * never accessed from the outside. It stores process-wide VLC variables,
+ * mostly process-wide locks, and (currently) the module bank and objects tree.
+ */
+typedef struct libvlc_global_data_t
 {
     VLC_COMMON_MEMBERS
 
@@ -124,7 +124,7 @@ struct libvlc_global_data_t
 #elif defined( WIN32 )
     char *                 psz_vlcpath;
 #endif
-};
+} libvlc_global_data_t;
 
 
 libvlc_global_data_t *vlc_global (void);