Commit e27df5b6 authored by Antoine Cellerier's avatar Antoine Cellerier

Document module_Need's side effect on the object name.

parent 177d9f10
...@@ -328,6 +328,12 @@ const char *module_GetHelp( const module_t *m ) ...@@ -328,6 +328,12 @@ const char *module_GetHelp( const module_t *m )
* module Need * module Need
* *
* Return the best module function, given a capability list. * Return the best module function, given a capability list.
*
* If the p_this object doesn't have it's psz_object_name set, then
* psz_object_name will be set to the module's name, unless the user
* provided an alias using the "module name@alias" syntax in which case
* psz_object_name will be set to the alias.
*
* \param p_this the vlc object * \param p_this the vlc object
* \param psz_capability list of capabilities needed * \param psz_capability list of capabilities needed
* \param psz_name name of the module asked * \param psz_name name of the module asked
......
Markdown is supported
0%
or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment