MDL-44315 phpdoc: fixed up typos and made up tags

admin/tool/spamcleaner/index.php

@@ -5,7 +5,9 @@
  *
  * Helps an admin to clean up spam in Moodle
  *
- * @authors Dongsheng Cai, Martin Dougiamas, Amr Hourani
+ * @author Dongsheng Cai
+ * @author Martin Dougiamas
+ * @author Amr Hourani
  * @license http://www.gnu.org/copyleft/gpl.html GNU Public License
  */
 

lib/ajax/ajaxlib.php

@@ -46,7 +46,7 @@ function user_preference_allow_ajax_update($name, $paramtype) {
  * This should be used in combination with ajax_check_captured_output to
  * report any captured output to the user.
  *
- * @retrun Boolean Returns true on success or false on failure.
+ * @return Boolean Returns true on success or false on failure.
  */
 function ajax_capture_output() {
     // Start capturing output in case of broken plugins.

lib/cronlib.php

@@ -773,7 +773,7 @@ function notify_login_failures() {
 /**
  * Delete files and directories older than one week from directory provided by $CFG->tempdir.
  *
- * @exception Exception Failed reading/accessing file or directory
+ * @throws Exception Failed reading/accessing file or directory
  * @return bool True on successful file and directory deletion; otherwise, false on failure
  */
 function cron_delete_from_temp() {

lib/dtl/database_exporter.php

@@ -122,7 +122,7 @@ abstract class database_exporter {
      * @see $check_schema is true), queries the database and calls
      * appropriate callbacks.
      *
-     * @exception dbtransfer_exception if any checking (e.g. database schema) fails
+     * @throws dbtransfer_exception if any checking (e.g. database schema) fails
      *
      * @param string $description a user description of the data.
      */

lib/dtl/database_importer.php

@@ -90,7 +90,7 @@ class database_importer {
      * operation, before any database changes are made. It will check the database
      * schema if @see check_schema is true
      *
-     * @exception dbtransfer_exception if any checking (e.g. database schema, Moodle
+     * @throws dbtransfer_exception if any checking (e.g. database schema, Moodle
      * version) fails
      *
      * @param float $version the version of the system which generated the data
@@ -131,8 +131,8 @@ class database_importer {
      * Callback function. Should be called only once per table import operation,
      * before any table changes are made. It will delete all table data.
      *
-     * @exception dbtransfer_exception an unknown table import is attempted
-     * @exception ddl_table_missing_exception if the table is missing
+     * @throws dbtransfer_exception an unknown table import is attempted
+     * @throws ddl_table_missing_exception if the table is missing
      *
      * @param string $tablename - the name of the table that will be imported
      * @param string $schemaHash - the hash of the xmldb_table schema of the table
@@ -191,7 +191,7 @@ class database_importer {
      * between @see begin_table_import and @see finish_table_import calls.
      * It will insert table data.
      *
-     * @exception dml_exception if data insert operation failed
+     * @throws dml_exception if data insert operation failed
      *
      * @param string $tablename - the name of the table in which data will be
      * imported

lib/dtl/file_xml_database_exporter.php

@@ -60,7 +60,7 @@ class file_xml_database_exporter extends xml_database_exporter {
      * Specific implementation for file exporting the database: it opens output stream, calls
      * superclass @see database_exporter::export_database() and closes output stream.
      *
-     * @exception dbtransfer_exception if any checking (e.g. database schema) fails
+     * @throws dbtransfer_exception if any checking (e.g. database schema) fails
      *
      * @param string $description a user description of the data.
      */

lib/dtl/string_xml_database_exporter.php

@@ -51,7 +51,7 @@ class string_xml_database_exporter extends xml_database_exporter {
      * Specific implementation for memory exporting the database: it clear the buffer
      * and calls superclass @see database_exporter::export_database().
      *
-     * @exception dbtransfer_exception if any checking (e.g. database schema) fails
+     * @throws dbtransfer_exception if any checking (e.g. database schema) fails
      * @param string $description a user description of the data.
      * @return void
      */

lib/filestorage/file_exceptions.php

@@ -121,7 +121,7 @@ class file_pool_content_exception extends file_exception {
  * Problem with records in the {files_reference} table.
  *
  * @package   core_files
- * @catehory  files
+ * @category  files
  * @copyright 2012 David Mudrak <david@moodle.com>
  * @license   http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
  */

lib/pagelib.php

@@ -1787,7 +1787,6 @@ class moodle_page {
 
     /**
      * Ensure the theme has not been loaded yet. If it has an exception is thrown.
-     * @source
      *
      * @throws coding_exception
      */

lib/statslib.php

@@ -1701,7 +1701,7 @@ function stats_temp_table_drop() {
  *
  * @param timestart timestamp of the start time of logs view
  * @param timeend timestamp of the end time of logs view
- * @returns boolen success (true) or failure(false)
+ * @return boolen success (true) or failure(false)
  */
 function stats_temp_table_setup() {
     global $DB;
@@ -1724,7 +1724,7 @@ function stats_temp_table_setup() {
  *
  * @param timestart timestamp of the start time of logs view
  * @param timeend timestamp of the end time of logs view
- * @returns boolen success (true) or failure(false)
+ * @return boolen success (true) or failure(false)
  */
 function stats_temp_table_fill($timestart, $timeend) {
     global $DB;
@@ -1752,7 +1752,7 @@ function stats_temp_table_fill($timestart, $timeend) {
 /**
  * Deletes summary logs table for stats calculation
  *
- * @returns boolen success (true) or failure(false)
+ * @return boolen success (true) or failure(false)
  */
 function stats_temp_table_clean() {
     global $DB;

mod/assign/feedback/editpdf/fpdi/fpdf_tpl.php

@@ -189,7 +189,7 @@ class FPDF_TPL extends FPDF {
      * @param int $_y The y-position
      * @param int $_w The new width of the template
      * @param int $_h The new height of the template
-     * @retrun array The height and width of the template
+     * @return array The height and width of the template
      */
     function useTemplate($tplidx, $_x = null, $_y = null, $_w = 0, $_h = 0) {
         if ($this->page <= 0)

mod/forum/search.php

@@ -431,7 +431,7 @@ function forum_print_big_search_form($course) {
  *
  * @param string $words String containing space-separated strings to search for
  * @param string $prefix String to prepend to the each token taken out of $words
- * @returns array
+ * @return array
  * @todo Take the hardcoded limit out of this function and put it into a user-specified parameter
  */
 function forum_clean_search_terms($words, $prefix='') {

theme/bootstrapbase/config.php

@@ -25,7 +25,8 @@
  *
  * @package   theme_bootstrapbase
  * @copyright 2013 Bas Brands. www.sonsbeekmedia.nl
- * @authors   Bas Brands, David Scotson
+ * @author    Bas Brands
+ * @author    David Scotson
  * @license   http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
  */
 

theme/bootstrapbase/version.php

@@ -19,7 +19,8 @@
  *
  * @package    theme_bootstrapbase
  * @copyright  2013 Bas Brands, www.basbrands.nl
- * @authors    Bas Brands, David Scotson
+ * @author     Bas Brands
+ * @author     David Scotson
  * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
  */