* Strings review in include/

[vlc] / include / vlc_objects.h

diff --git a/include/vlc_objects.h b/include/vlc_objects.h
index f1e4757e9c23b15c5c205da6e7862ad5f5b4a8f8..4f6a5aab35ba0bbbedde1ed125988b315be9b199 100644 (file)
--- a/include/vlc_objects.h
+++ b/include/vlc_objects.h
@@ -2,7 +2,7 @@
  * vlc_objects.h: vlc_object_t definition.
  *****************************************************************************
  * Copyright (C) 2002 VideoLAN
- * $Id: vlc_objects.h,v 1.16 2003/02/23 19:07:02 fenrir Exp $
+ * $Id: vlc_objects.h,v 1.22 2004/01/25 18:17:08 zorglub Exp $
  *
  * Authors: Samuel Hocevar <sam@zoy.org>
  *
@@ -10,7 +10,7 @@
  * it under the terms of the GNU General Public License as published by
  * the Free Software Foundation; either version 2 of the License, or
  * (at your option) any later version.
- * 
+ *
  * This program is distributed in the hope that it will be useful,
  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
@@ -21,6 +21,16 @@
  * Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA  02111, USA.
  *****************************************************************************/
 
+/**
+ * \file
+ * This file defines the vlc_object_t structure and object types
+ */
+
+/**
+ * \defgroup vlc_object Objects
+ * @{
+ */
+
 /* Object types */
 #define VLC_OBJECT_ROOT       (-1)
 #define VLC_OBJECT_VLC        (-2)
@@ -34,6 +44,9 @@
 #define VLC_OBJECT_AOUT      (-10)
 #define VLC_OBJECT_SOUT      (-11)
 #define VLC_OBJECT_HTTPD     (-12)
+#define VLC_OBJECT_PACKETIZER (-13)
+#define VLC_OBJECT_ENCODER   (-14)
+#define VLC_OBJECT_DIALOGS   (-15)
 
 #define VLC_OBJECT_GENERIC  (-666)
 
@@ -47,6 +60,7 @@
 /*****************************************************************************
  * The vlc_object_t type. Yes, it's that simple :-)
  *****************************************************************************/
+/** The main vlc_object_t structure */
 struct vlc_object_t
 {
     VLC_COMMON_MEMBERS
@@ -66,6 +80,8 @@ VLC_EXPORT( void, __vlc_object_release, ( vlc_object_t * ) );
 VLC_EXPORT( vlc_list_t *, __vlc_list_find, ( vlc_object_t *, int, int ) );
 VLC_EXPORT( void, vlc_list_release, ( vlc_list_t * ) );
 
+/*}@*/
+
 #define vlc_object_create(a,b) \
     __vlc_object_create( VLC_OBJECT(a), b )