[vlc-devel] commit: Document module_Need's side effect on the object name. ( Antoine Cellerier )

[git version control]

vlc | branch: master | Antoine Cellerier <dionoea at videolan.org> | Sat Sep  6 15:12:07 2008 +0200| [e27df5b6ea4070e5cad52beefc01f6e0dfd2754b] | committer: Antoine Cellerier 

Document module_Need's side effect on the object name.

> http://git.videolan.org/gitweb.cgi/vlc.git/?a=commit;h=e27df5b6ea4070e5cad52beefc01f6e0dfd2754b
---

 src/modules/modules.c |    6 ++++++
 1 files changed, 6 insertions(+), 0 deletions(-)

diff --git a/src/modules/modules.c b/src/modules/modules.c
index 84f30d9..999c1e4 100644
--- a/src/modules/modules.c
+++ b/src/modules/modules.c
@@ -328,6 +328,12 @@ const char *module_GetHelp( const module_t *m )
  * module Need
  *
  * 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 at alias" syntax in which case
+ * psz_object_name will be set to the alias.
+ *
  * \param p_this the vlc object
  * \param psz_capability list of capabilities needed
  * \param psz_name name of the module asked