From 52f79e8fd488915249b2e6c23879f9e4e86c0a95 Mon Sep 17 00:00:00 2001
From: jamiesensei <jamiesensei>
Date: Tue, 19 Jun 2007 15:20:16 +0000
Subject: [PATCH] elaborated phpdoc comment slightly for  doc_link

---
 lib/weblib.php | 3 ++-
 1 file changed, 2 insertions(+), 1 deletion(-)

diff --git a/lib/weblib.php b/lib/weblib.php
index 05b8ddfb2bd..8485c99eebc 100644
--- a/lib/weblib.php
+++ b/lib/weblib.php
@@ -4926,7 +4926,8 @@ function page_doc_link($text='', $iconpath='') {
  * Also contains an icon by default. Shown to teachers and admin only.
  *
  * @param string $path      The relative link
- * @param string $text      The text to be displayed for the link
+ * @param string $path      The page link after doc root and language, no
+ *                              leading slash.
  * @param string $iconpath  The path to the icon to be displayed
  */
 function doc_link($path='', $text='', $iconpath='') {