Changeset e769bca04c56a67ab39ee2d2700508a9c5ad8910

Show
Ignore:
Timestamp:
02/26/08 01:17:42 (6 months ago)
Author:
Rémi Duraffort <ivoire@videolan.org>
git-committer:
Rémi Duraffort <ivoire@videolan.org> 1203985062 +0000
git-parent:

[7f1f444ca32b4670e34a2a52b5e99e5381c9333a]

git-author:
Rémi Duraffort <ivoire@videolan.org> 1203985062 +0000
Message:

Doxygen documentation

Files:

Legend:

Unmodified
Added
Removed
Modified
Copied
Moved

  • src/modules/os.c

    r99fab90 re769bca  
    7676#endif 
    7777 
    78 /***************************************************************************** 
    79  * module_Call: call an entry point. 
    80  ***************************************************************************** 
    81  * This function calls a symbol given its name and a module structure. The 
    82  * symbol MUST refer to a function returning int and taking a module_t* as 
    83  * an argument. 
    84  *****************************************************************************/ 
    85 int module_Call( module_t * p_module ) 
     78/** 
     79 * module Call 
     80 * 
     81 * Call a symbol given its name and a module structure. The symbol MUST 
     82 * refer to a function returning int and taking a module_t* as an argument. 
     83 * \param p_module the modules 
     84 * \return 0 if it pass and -1 in case of a failure 
     85 */ 
     86int module_Call( module_t *p_module ) 
    8687{ 
    8788    static const char psz_name[] = "vlc_entry" MODULE_SUFFIX; 
    …… 
    127128} 
    128129 
    129 /***************************************************************************** 
    130  * module_Load: loads a dynamic library 
    131  ***************************************************************************** 
    132  * This function loads a dynamically linked library using a system dependant 
    133  * method. Will return 0 on success as well as the module handle. 
    134  *****************************************************************************/ 
     130/** 
     131 * Load a dynamically linked library using a system dependant method. 
     132 * 
     133 * \param p_this vlc object 
     134 * \param psz_file library file 
     135 * \param p_handle the module handle returned 
     136 * \return 0 on success as well as the module handle. 
     137 */ 
    135138int module_Load( vlc_object_t *p_this, const char *psz_file, 
    136139                 module_handle_t *p_handle ) 
    …… 
    234237} 
    235238 
    236 /***************************************************************************** 
     239/** 
    237240 * CloseModule: unload a dynamic library 
    238  ***************************************************************************** 
     241 * 
    239242 * This function unloads a previously opened dynamically linked library 
    240243 * using a system dependant method. No return value is taken in consideration, 
    241244 * since some libraries sometimes refuse to close properly. 
    242  *****************************************************************************/ 
     245 * \param handle handle of the library 
     246 * \return nothing 
     247 */ 
    243248void module_Unload( module_handle_t handle ) 
    244249{ 
    …… 
    264269} 
    265270 
    266 /***************************************************************************** 
     271/** 
    267272 * GetSymbol: get a symbol from a dynamic library 
    268  ***************************************************************************** 
     273 * 
    269274 * This function queries a loaded library for a symbol specified in a 
    270275 * string, and returns a pointer to it. We don't check for dlerror() or 
    271276 * similar functions, since we want a non-NULL symbol anyway. 
    272  *****************************************************************************/ 
     277 * \param handle handle to the module 
     278 * \param psz_function function name 
     279 * \return nothing 
     280 */ 
    273281static void * _module_getsymbol( module_handle_t, const char * ); 
    274282