weblib: MDL-14901 Fix misleading comment on print_navigation

diff --git a/lib/weblib.php b/lib/weblib.php
index fa2241598a11221421fb79e28d3aa081c210dc69..310cdd3fbce225e194672327a492d8edfdaae771 100644 (file)
--- a/lib/weblib.php
+++ b/lib/weblib.php
@@ -3565,9 +3565,9 @@ function get_separator() {
  *
  * @uses $CFG
  * @param mixed $navigation The breadcrumb navigation string to be printed
- * @param string $separator The breadcrumb trail separator. The default 0 leads to the use
- *  of $THEME->rarrow, themes could use '→', '/', or '' for a style-sheet solution.
+ * @param string $separator OBSOLETE, mostly not used any more. See build_navigation instead.
  * @param boolean $return False to echo the breadcrumb string (default), true to return it.
+ * @return string or null, depending on $return.
  */
 function print_navigation ($navigation, $separator=0, $return=false) {
     global $CFG, $THEME, $SITE;