Permalink
Browse files

elaborated phpdoc comment slightly for doc_link

  • Loading branch information...
1 parent fc2df8c commit 3db1ddedd38b6fbea734ed5f9922d74906841965 jamiesensei committed Jun 19, 2007
Showing with 2 additions and 1 deletion.
  1. +2 −1 lib/weblib.php
View
@@ -5798,7 +5798,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
*/

0 comments on commit 3db1dde

Please sign in to comment.