module_GetHelp
authorRémi Denis-Courmont <rem@videolan.org>
Sat, 4 Aug 2007 17:58:18 +0000 (17:58 +0000)
committerRémi Denis-Courmont <rem@videolan.org>
Sat, 4 Aug 2007 17:58:18 +0000 (17:58 +0000)
include/vlc_modules.h
src/libvlc.sym
src/modules/modules.c

index 0fb0028..3388b7a 100644 (file)
@@ -46,7 +46,7 @@ typedef shl_t module_handle_t;
 /**
  * Module descriptor
  */
-#ifndef __PLUGIN__
+#ifndef __PLUGIN__FIXME
 /* FIXME: scheduled for privatization */
 struct module_t
 {
@@ -134,4 +134,5 @@ enum vlc_module_properties
 VLC_EXPORT( vlc_bool_t, module_IsCapable, ( const module_t *m, const char *cap ) );
 VLC_EXPORT( const char *, module_GetObjName, ( const module_t *m ) );
 VLC_EXPORT( const char *, module_GetName, ( const module_t *m, vlc_bool_t long_name ) );
-
+#define module_GetLongName( m ) module_GetName( m, VLC_TRUE )
+VLC_EXPORT( const char *, module_GetHelp, ( const module_t *m ) );
index cbf5032..edb211f 100644 (file)
@@ -180,6 +180,7 @@ __module_Unneed
 module_IsCapable
 module_GetObjName
 module_GetName
+module_GetHelp
 __msg_Dbg
 __msg_Err
 __msg_Generic
index 767b537..2189bc5 100644 (file)
@@ -402,7 +402,7 @@ const char *module_GetObjName( const module_t *m )
 /*****************************************************************************
  * module_GetName: human-friendly name of a module.
  *****************************************************************************/
-const char *module_GetName(const module_t *m, vlc_bool_t long_name )
+const char *module_GetName( const module_t *m, vlc_bool_t long_name )
 {
     if( long_name && ( m->psz_longname != NULL) )
         return m->psz_longname;
@@ -410,6 +410,11 @@ const char *module_GetName(const module_t *m, vlc_bool_t long_name )
     return m->psz_shortname ?: m->psz_object_name;
 }
 
+const char *module_GetHelp( const module_t *m )
+{
+    return m->psz_help;
+}
+
 /*****************************************************************************
  * module_Need: return the best module function, given a capability list.
  *****************************************************************************