elaborated phpdoc comment slightly for doc_link

moodle · Jun 19, 2007 · 416622f · 416622f
1 parent 8f95983
commit 416622f
Showing 1 changed file with 2 additions and 1 deletion.
diff --git a/lib/weblib.php b/lib/weblib.php
@@ -5382,7 +5382,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
  */