elaborated phpdoc comment slightly for doc_link

diff --git a/lib/weblib.php b/lib/weblib.php
index 9c113333b5e665438ba75e011bf146092bcbd551..129487a47a482cfee2ac9df1af9d25ed48d69ca7 100644 (file)
--- 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
  */