From: jamiesensei <jamiesensei>
Date: Tue, 19 Jun 2007 15:21:27 +0000 (+0000)
Subject: elaborated phpdoc comment slightly for  doc_link
X-Git-Url: http://git.mjollnir.org/gw?a=commitdiff_plain;h=4579011918465dcbcd2c25de17e3a552881f0d09;p=moodle.git

elaborated phpdoc comment slightly for  doc_link
---

diff --git a/lib/weblib.php b/lib/weblib.php
index 9c113333b5..129487a47a 100644
--- a/lib/weblib.php
+++ b/lib/weblib.php
@@ -6123,7 +6123,8 @@ function page_doc_link($text='', $iconpath='') {
  * Returns a string containing a link to the user documentation.
  * Also contains an icon by default. Shown to teachers and admin only.
  *
- * @param string $path      The relative link
+ * @param string $path      The page link after doc root and language, no
+ *                              leading slash.
  * @param string $text      The text to be displayed for the link
  * @param string $iconpath  The path to the icon to be displayed
  */