MDL-30979 output: Further changes are validation
authorSam Hemelryk <sam@moodle.com>
Tue, 14 Feb 2012 05:24:09 +0000 (18:24 +1300)
committerSam Hemelryk <sam@moodle.com>
Fri, 17 Feb 2012 01:53:11 +0000 (14:53 +1300)
lib/outputactions.php
lib/outputcomponents.php
lib/outputfactories.php
lib/outputlib.php
lib/outputrenderers.php
lib/outputrequirementslib.php

index 06ef730..12c10c3 100644 (file)
@@ -20,7 +20,7 @@
  * Please see http://docs.moodle.org/en/Developement:How_Moodle_outputs_HTML
  * for an overview.
  *
- * @package core_output
+ * @package core
  * @category output
  * @copyright 2009 Nicolas Connault
  * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
@@ -34,7 +34,7 @@ defined('MOODLE_INTERNAL') || die();
  * @copyright 2009 Nicolas Connault
  * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
  * @since Moodle 2.0
- * @package core_output
+ * @package core
  * @category output
  */
 class component_action {
@@ -84,7 +84,7 @@ class component_action {
  * @copyright 2009 Nicolas Connault
  * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
  * @since Moodle 2.0
- * @package core_output
+ * @package core
  * @category output
  */
 class confirm_action extends component_action {
@@ -111,7 +111,7 @@ class confirm_action extends component_action {
  * @copyright 2009 Nicolas Connault
  * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
  * @since Moodle 2.0
- * @package core_output
+ * @package core
  * @category output
  */
 class popup_action extends component_action {
index 006b05e..3aef7e7 100644 (file)
@@ -1,5 +1,4 @@
 <?php
-
 // This file is part of Moodle - http://moodle.org/
 //
 // Moodle is free software: you can redistribute it and/or modify
@@ -21,7 +20,7 @@
  * Please see http://docs.moodle.org/en/Developement:How_Moodle_outputs_HTML
  * for an overview.
  *
- * @package core_output
+ * @package core
  * @category output
  * @copyright 2009 Tim Hunt
  * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
@@ -33,7 +32,7 @@ defined('MOODLE_INTERNAL') || die();
  * Interface marking other classes as suitable for renderer_base::render()
  *
  * @copyright 2010 Petr Skoda (skodak) info@skodak.org
- * @package core_output
+ * @package core
  * @category output
  */
 interface renderable {
@@ -46,7 +45,7 @@ interface renderable {
  * @copyright 2010 Dongsheng Cai
  * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
  * @since Moodle 2.0
- * @package core_output
+ * @package core
  * @category output
  */
 class file_picker implements renderable {
@@ -124,7 +123,7 @@ class file_picker implements renderable {
  * @copyright 2009 Nicolas Connault, 2010 Petr Skoda
  * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
  * @since Modle 2.0
- * @package core_output
+ * @package core
  * @category output
  */
 class user_picture implements renderable {
@@ -302,6 +301,7 @@ class user_picture implements renderable {
      * This method is recommended as it avoids costly redirects of user pictures
      * if requests are made for non-existent files etc.
      *
+     * @param moodle_page $page
      * @param renderer_base $renderer
      * @return moodle_url
      */
@@ -385,7 +385,7 @@ class user_picture implements renderable {
  * @copyright 2009 Nicolas Connault, 2010 Petr Skoda
  * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
  * @since Moodle 2.0
- * @package core_output
+ * @package core
  * @category output
  */
 class old_help_icon implements renderable {
@@ -416,7 +416,6 @@ class old_help_icon implements renderable {
      * @param string $helpidentifier  The keyword that defines a help page
      * @param string $title A descriptive text for accessibility only
      * @param string $component
-     * @param bool $linktext add extra text to icon
      */
     public function __construct($helpidentifier, $title, $component = 'moodle') {
         if (empty($title)) {
@@ -438,7 +437,7 @@ class old_help_icon implements renderable {
  * @copyright 2010 Petr Skoda (info@skodak.org)
  * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
  * @since Moodle 2.0
- * @package core_output
+ * @package core
  * @category output
  */
 class help_icon implements renderable {
@@ -494,7 +493,7 @@ class help_icon implements renderable {
  * @copyright 2010 Petr Skoda
  * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
  * @since Moodle 2.0
- * @package core_output
+ * @package core
  * @category output
  */
 class pix_icon implements renderable {
@@ -543,7 +542,7 @@ class pix_icon implements renderable {
  * @copyright 2010 David Mudrak
  * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
  * @since Moodle 2.0
- * @package core_output
+ * @package core
  * @category output
  */
 class pix_emoticon extends pix_icon implements renderable {
@@ -569,7 +568,7 @@ class pix_emoticon extends pix_icon implements renderable {
  * @copyright 2009 Petr Skoda
  * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
  * @since Moodle 2.0
- * @package core_output
+ * @package core
  * @category output
  */
 class single_button implements renderable {
@@ -630,7 +629,7 @@ class single_button implements renderable {
      * Shortcut for adding a JS confirm dialog when the button is clicked.
      * The message must be a yes/no question.
      *
-     * @param string $message The yes/no confirmation question. If "Yes" is clicked, the original action will occur.
+     * @param string $confirmmessage The yes/no confirmation question. If "Yes" is clicked, the original action will occur.
      */
     public function add_confirm_action($confirmmessage) {
         $this->add_action(new confirm_action($confirmmessage));
@@ -648,12 +647,13 @@ class single_button implements renderable {
 
 /**
  * Simple form with just one select field that gets submitted automatically.
+ *
  * If JS not enabled small go button is printed too.
  *
  * @copyright 2009 Petr Skoda
  * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
  * @since Moodle 2.0
- * @package core_output
+ * @package core
  * @category output
  */
 class single_select implements renderable {
@@ -748,7 +748,7 @@ class single_select implements renderable {
      * Shortcut for adding a JS confirm dialog when the button is clicked.
      * The message must be a yes/no question.
      *
-     * @param string $message The yes/no confirmation question. If "Yes" is clicked, the original action will occur.
+     * @param string $confirmmessage The yes/no confirmation question. If "Yes" is clicked, the original action will occur.
      */
     public function add_confirm_action($confirmmessage) {
         $this->add_action(new component_action('submit', 'M.util.show_confirm_dialog', array('message' => $confirmmessage)));
@@ -766,10 +766,9 @@ class single_select implements renderable {
     /**
      * Adds help icon.
      *
-     * @param string $page  The keyword that defines a help page
+     * @param string $helppage  The keyword that defines a help page
      * @param string $title A descriptive text for accessibility only
      * @param string $component
-     * @param bool $linktext add extra text to icon
      */
     public function set_old_help_icon($helppage, $title, $component = 'moodle') {
         $this->helpicon = new old_help_icon($helppage, $title, $component);
@@ -801,7 +800,7 @@ class single_select implements renderable {
  * @copyright 2009 Petr Skoda
  * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
  * @since Moodle 2.0
- * @package core_output
+ * @package core
  * @category output
  */
 class url_select implements renderable {
@@ -883,7 +882,7 @@ class url_select implements renderable {
     /**
      * Adds help icon.
      *
-     * @param string $page  The keyword that defines a help page
+     * @param string $helppage  The keyword that defines a help page
      * @param string $title A descriptive text for accessibility only
      * @param string $component
      */
@@ -917,7 +916,7 @@ class url_select implements renderable {
  * @copyright 2010 Petr Skoda
  * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
  * @since Moodle 2.0
- * @package core_output
+ * @package core
  * @category output
  */
 class action_link implements renderable {
@@ -986,7 +985,7 @@ class action_link implements renderable {
  * @copyright 2009 Tim Hunt, 2010 Petr Skoda
  * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
  * @since Moodle 2.0
- * @package core_output
+ * @package core
  * @category output
  */
 class html_writer {
@@ -1180,8 +1179,8 @@ class html_writer {
      *                array(1=>'One', '--1uniquekey'=>array('More'=>array(2=>'Two', 3=>'Three')))
      * @param string $name name of select element
      * @param string|array $selected value or array of values depending on multiple attribute
-     * @param array|bool $nothing, add nothing selected option, or false of not added
-     * @param array $attributes html select element attributes
+     * @param array|bool $nothing add nothing selected option, or false of not added
+     * @param array $attributes html select element attributes
      * @return string HTML fragment
      */
     public static function select(array $options, $name, $selected = '', $nothing = array('' => 'choosedots'), array $attributes = null) {
@@ -1220,7 +1219,7 @@ class html_writer {
             $class = str_replace(']', '', $class);
             $attributes['class'] = $class;
         }
-        $attributes['class'] = 'select ' . $attributes['class']; /// Add 'select' selector always
+        $attributes['class'] = 'select ' . $attributes['class']; // Add 'select' selector always
 
         $attributes['name'] = $name;
 
@@ -1392,8 +1391,8 @@ class html_writer {
     /**
      * Generate a script tag containing the the specified code.
      *
-     * @param string $js the JavaScript code
-     * @param moodle_url|string optional url of the external script, $code ignored if specified
+     * @param string $jscode the JavaScript code
+     * @param moodle_url|string $url optional url of the external script, $code ignored if specified
      * @return string HTML, the code wrapped in <script> tags.
      */
     public static function script($jscode, $url=null) {
@@ -1690,7 +1689,7 @@ class html_writer {
  * @copyright 2010 Petr Skoda
  * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
  * @since Moodle 2.0
- * @package core_output
+ * @package core
  * @category output
  */
 class js_writer {
@@ -1799,7 +1798,8 @@ class js_writer {
     /**
      * Writes event handler attaching code
      *
-     * @param array|string $selector standard YUI selector for elements, may be array or string, element id is in the form "#idvalue"
+     * @param array|string $selector standard YUI selector for elements, may be
+     *     array or string, element id is in the form "#idvalue"
      * @param string $event A valid DOM event (click, mousedown, change etc.)
      * @param string $function The name of the function to call
      * @param array $arguments An optional array of argument parameters to pass to the function
@@ -1816,7 +1816,7 @@ class js_writer {
 }
 
 /**
- * Holds all the information required to render a <table> by {@see core_renderer::table()}
+ * Holds all the information required to render a <table> by {@link core_renderer::table()}
  *
  * Example of usage:
  * $t = new html_table();
@@ -1826,7 +1826,7 @@ class js_writer {
  * @copyright 2009 David Mudrak <david.mudrak@gmail.com>
  * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
  * @since Moodle 2.0
- * @package core_output
+ * @package core
  * @category output
  */
 class html_table {
@@ -1853,8 +1853,8 @@ class html_table {
 
     /**
      * @var array An array that can be used to make a heading span multiple columns.
-     * In this example, {@see html_table:$data} is supposed to have three columns. For the first two columns,
-     * the same heading is used. Therefore, {@see html_table::$head} should consist of two items.
+     * In this example, {@link html_table:$data} is supposed to have three columns. For the first two columns,
+     * the same heading is used. Therefore, {@link html_table::$head} should consist of two items.
      *
      * Example of usage:
      * $t->headspan = array(2,1);
@@ -1986,7 +1986,7 @@ class html_table {
  * @copyright 2009 Nicolas Connault
  * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
  * @since Moodle 2.0
- * @package core_output
+ * @package core
  * @category output
  */
 class html_table_row {
@@ -2034,7 +2034,7 @@ class html_table_row {
  * @copyright 2009 Nicolas Connault
  * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
  * @since Moodle 2.0
- * @package core_output
+ * @package core
  * @category output
  */
 class html_table_cell {
@@ -2101,7 +2101,7 @@ class html_table_cell {
  * @copyright 2009 Nicolas Connault
  * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
  * @since Moodle 2.0
- * @package core_output
+ * @package core
  * @category output
  */
 class paging_bar implements renderable {
@@ -2187,6 +2187,11 @@ class paging_bar implements renderable {
      *
      * This method validates the arguments set up for the paging bar and then
      * produces fragments of HTML to assist display later on.
+     *
+     * @param renderer_base $output
+     * @param moodle_page $page
+     * @param string $target
+     * @throws coding_exception
      */
     public function prepare(renderer_base $output, moodle_page $page, $target) {
         if (!isset($this->totalcount) || is_null($this->totalcount)) {
@@ -2260,7 +2265,7 @@ class paging_bar implements renderable {
  * During output, each block instance is asked to return a block_contents object,
  * those are then passed to the $OUTPUT->block function for display.
  *
- * {@link $contents} should probably be generated using a moodle_block_..._renderer.
+ * contents should probably be generated using a moodle_block_..._renderer.
  *
  * Other block-like things that need to appear on the page, for example the
  * add new block UI, are also represented as block_contents objects.
@@ -2268,7 +2273,7 @@ class paging_bar implements renderable {
  * @copyright 2009 Tim Hunt
  * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
  * @since Moodle 2.0
- * @package core_output
+ * @package core
  * @category output
  */
 class block_contents {
@@ -2390,7 +2395,7 @@ class block_contents {
  * @copyright 2009 Tim Hunt
  * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
  * @since Moodle 2.0
- * @package core_output
+ * @package core
  * @category output
  */
 class block_move_target {
@@ -2425,7 +2430,7 @@ class block_move_target {
  * @copyright 2010 Sam Hemelryk
  * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
  * @since Moodle 2.0
- * @package core_output
+ * @package core
  * @category output
  */
 class custom_menu_item implements renderable {
@@ -2606,7 +2611,7 @@ class custom_menu_item implements renderable {
  * @copyright 2010 Sam Hemelryk
  * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
  * @since Moodle 2.0
- * @package core_output
+ * @package core
  * @category output
  */
 class custom_menu extends custom_menu_item {
@@ -2620,7 +2625,7 @@ class custom_menu extends custom_menu_item {
      * Creates the custom menu
      *
      * @param string $definition the menu items definition in syntax required by {@link convert_text_to_menu_nodes()}
-     * @param string $language the current language code, null disables multilang support
+     * @param string $currentlanguage the current language code, null disables multilang support
      */
     public function __construct($definition = '', $currentlanguage = null) {
         $this->currentlanguage = $currentlanguage;
index 8efc595..cdfbf5e 100644 (file)
 // along with Moodle.  If not, see <http://www.gnu.org/licenses/>.
 
 /**
- * Interface and classes for creating appropriate renderers for various
- * parts of Moodle.
+ * Interface and classes for creating appropriate renderers for various parts of Moodle.
  *
  * Please see http://docs.moodle.org/en/Developement:How_Moodle_outputs_HTML
  * for an overview.
  *
  * @copyright 2009 Tim Hunt
  * @license  http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
- * @package core_output
+ * @package core
  * @category output
  */
 
@@ -60,7 +59,7 @@ define('RENDERER_TARGET_HTMLEMAIL', 'htmlemail');
  * @copyright 2009 Tim Hunt
  * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
  * @since Moodle 2.0
- * @package core_output
+ * @package core
  * @category output
  */
 interface renderer_factory {
@@ -106,7 +105,7 @@ interface renderer_factory {
  * @copyright 2009 Tim Hunt
  * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
  * @since Moodle 2.0
- * @package core_output
+ * @package core
  * @category output
  */
 abstract class renderer_factory_base implements renderer_factory {
@@ -204,13 +203,14 @@ abstract class renderer_factory_base implements renderer_factory {
 }
 
 /**
- * This is the default renderer factory for Moodle. It simply returns an instance
- * of the appropriate standard renderer class.
+ * This is the default renderer factory for Moodle.
+ *
+ * It simply returns an instance of the appropriate standard renderer class.
  *
  * @copyright 2009 Tim Hunt
  * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
  * @since Moodle 2.0
- * @package core_output
+ * @package core
  * @category output
  */
 class standard_renderer_factory extends renderer_factory_base {
@@ -243,8 +243,7 @@ class standard_renderer_factory extends renderer_factory_base {
 
 
 /**
- * This is renderer factory allows themes to override the standard renderers using
- * php code.
+ * This is renderer factory allows themes to override the standard renderers using php code.
  *
  * It will load any code from theme/mytheme/renderers.php and
  * theme/parenttheme/renderers.php, if then exist. Then whenever you ask for
@@ -255,7 +254,7 @@ class standard_renderer_factory extends renderer_factory_base {
  * @copyright 2009 Tim Hunt
  * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
  * @since Moodle 2.0
- * @package core_output
+ * @package core
  * @category output
  */
 class theme_overridden_renderer_factory extends renderer_factory_base {
index 9c4476f..9d53be7 100644 (file)
@@ -22,7 +22,7 @@
  *
  * @copyright 2009 Tim Hunt
  * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
- * @package core_output
+ * @package core
  * @category output
  */
 
@@ -99,7 +99,7 @@ function theme_get_revision() {
  * @copyright 2009 Tim Hunt
  * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
  * @since Moodle 2.0
- * @package core_output
+ * @package core
  * @category output
  */
 class theme_config {
@@ -112,7 +112,7 @@ class theme_config {
     /**
      * @var array You can base your theme on other themes by linking to the other theme as
      * parents. This lets you use the CSS and layouts from the other themes
-     * (see {@see theme_config::$layouts}).
+     * (see {@link theme_config::$layouts}).
      * That makes it easy to create a new theme that is similar to another one
      * but with a few changes. In this themes CSS you only need to override
      * those rules you want to change.
@@ -435,7 +435,7 @@ class theme_config {
         $this->check_theme_arrows();
     }
 
-    /*
+    /**
      * Checks if arrows $THEME->rarrow, $THEME->larrow have been set (theme/-/config.php).
      * If not it applies sensible defaults.
      *
@@ -473,7 +473,7 @@ class theme_config {
                 $this->larrow = '&lt;';
             }
 
-        /// RTL support - in RTL languages, swap r and l arrows
+            // RTL support - in RTL languages, swap r and l arrows
             if (right_to_left()) {
                 $t = $this->rarrow;
                 $this->rarrow = $this->larrow;
@@ -725,7 +725,7 @@ class theme_config {
      * Given an array of file paths or a single file path loads the contents of
      * the CSS file, processes it then returns it in the same structure it was given.
      *
-     * Can be used recursively on the results of {@see css_files}
+     * Can be used recursively on the results of {@link css_files}
      *
      * @param array|string $file An array of file paths or a single file path
      * @param array $keys An array of previous array keys [recursive addition]
@@ -818,9 +818,10 @@ class theme_config {
      * setting of its closest parent.
      *
      * @param string $variable The name of the setting the exclude setting to resolve
+     * @param string $default
      * @return mixed
      */
-    protected function resolve_excludes($variable, $default=null) {
+    protected function resolve_excludes($variable, $default = null) {
         $setting = $default;
         if (is_array($this->{$variable}) or $this->{$variable} === true) {
             $setting = $this->{$variable};
@@ -841,7 +842,7 @@ class theme_config {
     /**
      * Returns the content of the one huge javascript file merged from all theme javascript files.
      *
-     * @param bool $inhead
+     * @param bool $type
      * @return string
      */
     public function javascript_content($type) {
@@ -897,7 +898,7 @@ class theme_config {
      * Return the URL for an image
      *
      * @param string $imagename the name of the icon.
-     * @param string $component, specification of one plugin like in get_string()
+     * @param string $component specification of one plugin like in get_string()
      * @return moodle_url
      */
     public function pix_url($imagename, $component) {
@@ -1059,7 +1060,7 @@ class theme_config {
      * Get the renderer for a part of Moodle for this theme.
      *
      * @param moodle_page $page the page we are rendering
-     * @param string $module the name of part of moodle. E.g. 'core', 'quiz', 'qtype_multichoice'.
+     * @param string $component the name of part of moodle. E.g. 'core', 'quiz', 'qtype_multichoice'.
      * @param string $subtype optional subtype such as 'news' resulting to 'mod_forum_news'
      * @param string $target one of rendering target constants
      * @return renderer_base the requested renderer.
@@ -1217,7 +1218,7 @@ class theme_config {
  * @copyright 2009 Tim Hunt
  * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
  * @since Moodle 2.0
- * @package core_output
+ * @package core
  * @category output
  */
 class xhtml_container_stack {
index 08b1f92..52c1bab 100644 (file)
@@ -29,7 +29,7 @@
  *     - plugin_renderer_base:  A renderer class that should be extended by all
  *                              plugin renderers.
  *
- * @package core_output
+ * @package core
  * @category output
  * @copyright  2009 Tim Hunt
  * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
@@ -47,7 +47,7 @@ defined('MOODLE_INTERNAL') || die();
  * @copyright 2009 Tim Hunt
  * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
  * @since Moodle 2.0
- * @package core_output
+ * @package core
  * @category output
  */
 class renderer_base {
@@ -108,9 +108,9 @@ class renderer_base {
      *
      * This method adds a JS event for the provided component action to the page
      * and then returns the id that the event has been attached to.
-     * If no id has been provided then a new ID is generated by {@see html_writer::random_id()}
+     * If no id has been provided then a new ID is generated by {@link html_writer::random_id()}
      *
-     * @param component_action $actions
+     * @param component_action $action
      * @param string $id
      * @return string id of element, either original submitted or random new if not supplied
      */
@@ -177,10 +177,10 @@ class renderer_base {
 /**
  * Basis for all plugin renderers.
  *
- * @author    Petr Skoda (skodak)
- * @license   http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
- * @since     Moodle 2.0
- * @package    core
+ * @copyright Petr Skoda (skodak)
+ * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
+ * @since Moodle 2.0
+ * @package core
  * @category output
  */
 class plugin_renderer_base extends renderer_base {
@@ -188,7 +188,7 @@ class plugin_renderer_base extends renderer_base {
     /**
      * @var renderer_base|core_renderer A reference to the current renderer.
      * The renderer provided here will be determined by the page but will in 90%
-     * of cases by the {@see core_renderer}
+     * of cases by the {@link core_renderer}
      */
     protected $output;
 
@@ -245,7 +245,7 @@ class plugin_renderer_base extends renderer_base {
  * @copyright 2009 Tim Hunt
  * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
  * @since Moodle 2.0
- * @package core_output
+ * @package core
  * @category output
  */
 class core_renderer extends renderer_base {
@@ -253,19 +253,19 @@ class core_renderer extends renderer_base {
      * Do NOT use, please use <?php echo $OUTPUT->main_content() ?>
      * in layout files instead.
      * @deprecated
-     * @var string used in {@see core_renderer::header()}.
+     * @var string used in {@link core_renderer::header()}.
      */
     const MAIN_CONTENT_TOKEN = '[MAIN CONTENT GOES HERE]';
 
     /**
-     * @var string Used to pass information from {@see core_renderer::doctype()} to
-     * {@see core_renderer::standard_head_html()}.
+     * @var string Used to pass information from {@link core_renderer::doctype()} to
+     * {@link core_renderer::standard_head_html()}.
      */
     protected $contenttype;
 
     /**
-     * @var string Used by {@see core_renderer::redirect_message()} method to communicate
-     * with {@see core_renderer::header()}.
+     * @var string Used by {@link core_renderer::redirect_message()} method to communicate
+     * with {@link core_renderer::header()}.
      */
     protected $metarefreshtag = '';
 
@@ -360,7 +360,7 @@ class core_renderer extends renderer_base {
             $output .= '<meta http-equiv="pragma" content="no-cache" />' . "\n";
             $output .= '<meta http-equiv="expires" content="0" />' . "\n";
         }
-        // This is only set by the {@see redirect()} method
+        // This is only set by the {@link redirect()} method
         $output .= $this->metarefreshtag;
 
         // Check if a periodic refresh delay has been set and make sure we arn't
@@ -444,9 +444,9 @@ class core_renderer extends renderer_base {
     public function standard_footer_html() {
         global $CFG, $SCRIPT;
 
-        // This function is normally called from a layout.php file in {@see core_renderer::header()}
+        // This function is normally called from a layout.php file in {@link core_renderer::header()}
         // but some of the content won't be known until later, so we return a placeholder
-        // for now. This will be replaced with the real content in {@see core_renderer::footer()}.
+        // for now. This will be replaced with the real content in {@link core_renderer::footer()}.
         $output = $this->unique_performance_info_token;
         if ($this->page->devicetypeinuse == 'legacy') {
             // The legacy theme is in use print the notification
@@ -500,9 +500,9 @@ class core_renderer extends renderer_base {
      * @return string HTML fragment.
      */
     public function standard_end_of_body_html() {
-        // This function is normally called from a layout.php file in {@see core_renderer::header()}
+        // This function is normally called from a layout.php file in {@link core_renderer::header()}
         // but some of the content won't be known until later, so we return a placeholder
-        // for now. This will be replaced with the real content in {@see core_renderer::footer()}.
+        // for now. This will be replaced with the real content in {@link core_renderer::footer()}.
         return $this->unique_end_html_token;
     }
 
@@ -687,7 +687,7 @@ class core_renderer extends renderer_base {
      * and the start of the <body>.
      *
      * To control what is printed, you should set properties on $PAGE. If you
-     * are familiar with the old {@see print_header()} function from Moodle 1.9
+     * are familiar with the old {@link print_header()} function from Moodle 1.9
      * you will find that there are properties on $PAGE that correspond to most
      * of the old parameters to could be passed to print_header.
      *
@@ -849,7 +849,7 @@ class core_renderer extends renderer_base {
     /**
      * Output the row of editing icons for a block, as defined by the controls array.
      *
-     * @param array $controls an array like {@see block_contents::$controls}.
+     * @param array $controls an array like {@link block_contents::$controls}.
      * @return string HTML fragment.
      */
     public function block_controls($controls) {
@@ -869,7 +869,7 @@ class core_renderer extends renderer_base {
      * Prints a nice side block with an optional header.
      *
      * The content is described
-     * by a {@see core_renderer::block_contents} object.
+     * by a {@link core_renderer::block_contents} object.
      *
      * <div id="inst{$instanceid}" class="block_{$blockname} block">
      *      <div class="header"></div>
@@ -1086,7 +1086,7 @@ class core_renderer extends renderer_base {
      * Renders an action_link object.
      *
      * The provided link is renderer and the HTML returned. At the same time the
-     * associated actions are setup in JS by {@see core_renderer::add_action_handler()}
+     * associated actions are setup in JS by {@link core_renderer::add_action_handler()}
      *
      * @param action_link $link
      * @return string HTML fragment
@@ -1129,7 +1129,7 @@ class core_renderer extends renderer_base {
     /**
      * Renders an action_icon.
      *
-     * This function uses the {@see core_renderer::action_link()} method for the
+     * This function uses the {@link core_renderer::action_link()} method for the
      * most part. What it does different is prepare the icon as HTML and use it
      * as the link text.
      *
@@ -1676,7 +1676,7 @@ class core_renderer extends renderer_base {
      * Returns HTML to display a help icon.
      *
      * @deprecated since Moodle 2.0
-     * @param string $page The keyword that defines a help page
+     * @param string $helpidentifier The keyword that defines a help page
      * @param string $title A descriptive text for accessibility only
      * @param string $component component name
      * @param string|bool $linktext true means use $title as link text, string means link text value
@@ -1696,7 +1696,7 @@ class core_renderer extends renderer_base {
     /**
      * Implementation of user image rendering.
      *
-     * @param help_icon $helpicon A help icon instance
+     * @param old_help_icon $helpicon A help icon instance
      * @return string HTML fragment
      */
     protected function render_old_help_icon(old_help_icon $helpicon) {
@@ -2133,7 +2133,7 @@ EOD;
     /**
      * Do not call this function directly.
      *
-     * To terminate the current script with a fatal error, call the {@see print_error}
+     * To terminate the current script with a fatal error, call the {@link print_error}
      * function, or throw an exception. Doing either of those things will then call this
      * function to display the error, before terminating the execution.
      *
@@ -2717,7 +2717,7 @@ EOD;
  * @copyright 2009 Tim Hunt
  * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
  * @since Moodle 2.0
- * @package core_output
+ * @package core
  * @category output
  */
 class core_renderer_cli extends core_renderer {
@@ -2803,7 +2803,7 @@ class core_renderer_cli extends core_renderer {
  * @copyright 2010 Petr Skoda
  * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
  * @since Moodle 2.0
- * @package core_output
+ * @package core
  * @category output
  */
 class core_renderer_ajax extends core_renderer {
@@ -2854,6 +2854,11 @@ class core_renderer_ajax extends core_renderer {
      * Used to display a redirection message.
      * AJAX redirections should not occur and as such redirection messages
      * are discarded.
+     *
+     * @param moodle_url|string $encodedurl
+     * @param string $message
+     * @param int $delay
+     * @param bool $debugdisableredirect
      */
     public function redirect_message($encodedurl, $message, $delay, $debugdisableredirect) {}
 
@@ -2868,7 +2873,7 @@ class core_renderer_ajax extends core_renderer {
             @header('Content-type: application/json; charset=utf-8');
         }
 
-        /// Headers to make it not cacheable and json
+        // Headers to make it not cacheable and json
         @header('Cache-Control: no-store, no-cache, must-revalidate');
         @header('Cache-Control: post-check=0, pre-check=0', false);
         @header('Pragma: no-cache');
index bf14181..52dc0b2 100644 (file)
@@ -21,7 +21,7 @@
  *
  * @copyright 2009 Tim Hunt, 2010 Petr Skoda
  * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
- * @package core_output
+ * @package core
  * @category output
  */
 
@@ -53,7 +53,7 @@ defined('MOODLE_INTERNAL') || die();
  * @copyright 2009 Tim Hunt, 2010 Petr Skoda
  * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
  * @since Moodle 2.0
- * @package core_output
+ * @package core
  * @category output
  */
 class page_requirements_manager {
@@ -845,7 +845,7 @@ class page_requirements_manager {
      *     alert(M.str.moodle.fullnamedisplay);
      *
      * To substitute the placeholder at client side, use M.util.get_string()
-     * function. It implements the same logic as {@see get_string()}:
+     * function. It implements the same logic as {@link get_string()}:
      *
      *     // require the string in PHP but keep {$a} as it is
      *     $PAGE->requires->string_for_js('fullnamedisplay', 'moodle');