[sr-dev] git:master: core: load_module - updated function docs

[Daniel-Constantin Mierla]

Module: sip-router
Branch: master
Commit: c9c181f8b5ee63f176fad577bc89314ffd261d8e
URL:    http://git.sip-router.org/cgi-bin/gitweb.cgi/sip-router/?a=commit;h=c9c181f8b5ee63f176fad577bc89314ffd261d8e

Author: Daniel-Constantin Mierla <miconda at gmail.com>
Committer: Daniel-Constantin Mierla <miconda at gmail.com>
Date:   Fri May 29 14:02:20 2009 +0300

core: load_module - updated function docs

---

 sr_module.c |   11 +++++++----
 1 files changed, 7 insertions(+), 4 deletions(-)

diff --git a/sr_module.c b/sr_module.c
index e1da688..81ef9b3 100644
--- a/sr_module.c
+++ b/sr_module.c
@@ -243,11 +243,14 @@ static inline int version_control(void *handle, char *path)
 }
 
 /** load a sr module.
- * tries to load the module specified by path.
- * If modname does contain a '/' or a '.' it would be assumed to contain a 
- * path to the module and it will be used as give.
- * else <MODS_DIR>/<modname>.so will be tried and if this fails
+ * tries to load the module specified by mod_path.
+ * If mod_path is 'modname' or 'modname.so' then
+ *  <MODS_DIR>/<modname>.so will be tried and if this fails
  *  <MODS_DIR>/<modname>/<modname>.so
+ * If mod_path contain a '/' it is assumed to be the 
+ * path to the module and tried first. If fails and mod_path is not
+ * absolute path (not starting with '/') then will try:
+ *   <MODS_DIR>/mod_path
  * @param modname - path or module name
  * @return 0 on success , <0 on error
  */