Permalink
Browse files

elaborated phpdoc comment slightly for doc_link

  • Loading branch information...
1 parent 3bc52bd commit 52f79e8fd488915249b2e6c23879f9e4e86c0a95 jamiesensei committed Jun 19, 2007
Showing with 2 additions and 1 deletion.
  1. +2 −1 lib/weblib.php
View
3 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='') {

0 comments on commit 52f79e8

Please sign in to comment.