Changeset 7f1f444ca32b4670e34a2a52b5e99e5381c9333a

Timestamp:

02/26/08 00:26:45 (6 months ago)

Author:

Rémi Duraffort <ivoire@videolan.org>

git-committer:

Rémi Duraffort <ivoire@videolan.org> 1203982005 +0000

git-parent:

[3fd7eb0f358128381965ebd5614270b357d4ab15]

git-author:

Rémi Duraffort <ivoire@videolan.org> 1203982005 +0000

Message:

Doxygen comments and coding conventions

Files:

• src/modules/modules.c (modified) (20 diffs)

src/modules/modules.c

@@ -107 +107 @@
-static void module_LoadMain( vlc_object_t *p_this );
-
-***************************************************************************
-module_InitBank: create the module bank.
-****************************************************************************
-This function c
+
+Init bank
+
+C
- * on with all the modules found.
-
+
+
+
-void __module_InitBank( vlc_object_t *p_this )
-{
@@ -150 +152 @@
-
-
-***************************************************************************
-module_EndBank: empty the module bank.
-****************************************************************************
-This function u
+
+End bank
+
+U
- * bank in case of success.
-
+
+
+
-void __module_EndBank( vlc_object_t *p_this )
-{
@@ -180 +184 @@
-    var_Destroy( p_libvlc_global, "libvlc" );
-
+    /* Save the configuration */
-    config_AutoSaveConfigFile( p_this );
-
@@ -189 +194 @@
-        if( p_bank->pp_loaded_cache[p_bank->i_loaded_cache] )
-        {
-
-
+
+
+
-            free( p_bank->pp_loaded_cache[p_bank->i_loaded_cache]->psz_file );
-            free( p_bank->pp_loaded_cache[p_bank->i_loaded_cache] );
@@ -237 +243 @@
-}
-
-***************************************************************************
-module_LoadMain: l
-****************************************************************************
-This function f
+
+L
+
+F
- * This is very useful as it will allow us to consider the main program just
- * as another module, and for instance the configuration options of main will
- * be available in the module bank structure just as for every other module.
-
+
+
+
-static void module_LoadMain( vlc_object_t *p_this )
-{
@@ -266 +274 @@
-}
-
-
-
-
-
-
+
+
+
+
+
+
+
-void __module_LoadBuiltins( vlc_object_t * p_this )
-{
@@ -293 +303 @@
-}
-
-
-
-
-
-
+
+
+
+
+
+
+
+
-void __module_LoadPlugins( vlc_object_t * p_this )
-{
@@ -329 +342 @@
-}
-
-
-
-
+
+
+
+
+
+
+
-vlc_bool_t module_IsCapable( const module_t *m, const char *cap )
-{
@@ -337 +354 @@
-}
-
-
-
-
+
+
+
+
+
+
-const char *module_GetObjName( const module_t *m )
-{
@@ -345 +365 @@
-}
-
-
-
-
+
+
+
+
+
+
+
-const char *module_GetName( const module_t *m, vlc_bool_t long_name )
-{
-    if( long_name && ( m->psz_longname != NULL) )
-        return m->psz_longname;
-
+
-    return m->psz_shortname ?: m->psz_object_name;
-}
-
+/**
+ * Get the help for a module
+ *
+ * \param m the module
+ * \return the help
+ */
-const char *module_GetHelp( const module_t *m )
-{
@@ -361 +391 @@
-}
-
-
-
-
-
-
+
+
+
+
+
+
+
+
+
+
-module_t * __module_Need( vlc_object_t *p_this, const char *psz_capability,
-                          const char *psz_name, vlc_bool_t b_strict )
@@ -670 +705 @@
-}
-
-***************************************************************************
-module_Unneed: decrease the usage count of a module.
-****************************************************************************
+
+Module unneed
+
- * This function must be called by the thread that called module_Need, to
- * decrease the reference count and allow for hiding of modules.
-
+
+
+
+
-void __module_Unneed( vlc_object_t * p_this, module_t * p_module )
-{
@@ -691 +729 @@
-}
-
-
-
-
+
+
+
+
+
+
+
-module_t *__module_Find( vlc_object_t *p_this, const char * psz_name )
-{
@@ -716 +758 @@
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
-{
-    module_t *p_module = __module_Find( p_this, psz_name );
@@ -744 +791 @@
-}
-
-
-
-
+
+
+
+
+
- * Free after uses both the string and the table.
-
+
+
+
+
+
+
-char ** __module_GetModulesNamesForCapability( vlc_object_t *p_this,
- 
+
-                                               char ***pppsz_longname )
-{
-    vlc_list_t *p_list;
-    int i, j, count = 0;
- 
-
-
+
+
+: count the number of modules before 
-    p_list = vlc_list_find( p_this, VLC_OBJECT_MODULE, FIND_ANYWHERE );
-    for( i = 0 ; i < p_list->i_count; i++)
@@ -766 +820 @@
-            count++;
-    }
+    /* FIXME: must check the return value and modify the calling functions
+              to test for a NULL : potential segfault */
-    psz_ret = malloc( sizeof(char*) * (count+1) );
-    if( pppsz_longname )
@@ -796 +852 @@
-}
-
-
-
+
+
+
+
+
+
+
+
-{
-    unsigned i,j;
-    unsigned size = module->confsize;
- (size * sizeof (*config)
-
- (psize != NULL
+( size * sizeof( *config ) 
+
+( psize != NULL 
-    *psize = 0;
-
- (i = 0, j = 0; i < size; i++
+( i = 0, j = 0; i < size; i++ 
-    {
-        const module_config_t *item = module->p_config + i;
- (
+( 
-         || item->b_unsaveable /* non-modifiable option */
-
+ 
-            continue;
-
- (config != NULL
- (config + j, item, sizeof (*config)
+( config != NULL 
+( config + j, item, sizeof( *config ) 
-        j++;
-    }
@@ -823 +885 @@
-}
-
-
-
-
+
+
+
+
+
+
+
+
+
-}
-
@@ -851 +919 @@
-    path[sizeof(path)/sizeof(path[0]) - 2] = userpath;
-
- (ppsz_path = path; *ppsz_path != NULL; ppsz_path++
+( ppsz_path = path; *ppsz_path != NULL; ppsz_path++ 
-    {
-        char *psz_fullpath;
-
- (!**ppsz_path
+( !**ppsz_path 
-
-#if defined( SYS_BEOS ) || defined( __APPLE__ ) || defined( WIN32 )
@@ -1023 +1091 @@
-
-    /* Parse the directory and try to load all files it contains. */
-file = readdir( dir )
+ file = readdir( dir ) 
-    {
-        struct stat statbuf;