Update the documentation for Travis.

gjbarnard · Nov 8, 2020 · 6b5fda3 · 6b5fda3
1 parent 54246f2
commit 6b5fda3
Show file tree

Hide file tree

Showing 6 changed files with 29 additions and 13 deletions.
diff --git a/block_theme_selector.php b/block_theme_selector.php
@@ -17,8 +17,7 @@
 /**
  * Theme selector block.
  *
- * @package    block
- * @subpackage theme_selector
+ * @package    block_theme_selector
  * @copyright  &copy; 2015-onwards G J Barnard in respect to modifications of original code:
  *             https://github.com/johntron/moodle-theme-selector-block by John Tron, see:
  *             https://github.com/johntron/moodle-theme-selector-block/issues/1.
@@ -27,20 +26,41 @@
  */
 defined('MOODLE_INTERNAL') || die;
 
+/**
+ * Theme selector block class.
+ */
 class block_theme_selector extends block_base {
 
+    /**
+     * Initialise the block.
+     */
     public function init() {
         $this->title = get_string('pluginname', 'block_theme_selector');
     }
 
+    /**
+     * States if the block has a configuration.
+     *
+     * @return boolean success.
+     */
     public function has_config() {
         return true;
     }
 
+    /**
+     * States if the block can hide the header.
+     *
+     * @return boolean success.
+     */
     public function hide_header() {
         return false;
     }
 
+    /**
+     * Gets the content of the block.
+     *
+     * @return string Markup.
+     */
     public function get_content() {
         if ($this->content !== null) {
             return $this->content;

diff --git a/db/access.php b/db/access.php
@@ -17,8 +17,7 @@
 /**
  * Theme selector block.
  *
- * @package    block
- * @subpackage theme_selector
+ * @package    block_theme_selector
  * @copyright  &copy; 2015-onwards G J Barnard in respect to modifications of original code:
  *             https://github.com/johntron/moodle-theme-selector-block by John Tron, see:
  *             https://github.com/johntron/moodle-theme-selector-block/issues/1.

diff --git a/db/upgrade.php b/db/upgrade.php
@@ -17,8 +17,7 @@
 /**
  * Theme selector block.
  *
- * @package    block
- * @subpackage theme_selector
+ * @package    block_theme_selector
  * @copyright  &copy; 2015-onwards G J Barnard in respect to modifications of original code:
  *             https://github.com/johntron/moodle-theme-selector-block by John Tron, see:
  *             https://github.com/johntron/moodle-theme-selector-block/issues/1.
@@ -31,7 +30,8 @@
 /**
  * Upgrade code for the theme selector block.
  *
- * @param int $oldversion
+ * @param int $oldversion.
+ * @return boolean success.
  */
 function xmldb_block_theme_selector_upgrade($oldversion = 0) {
 

diff --git a/lang/en/block_theme_selector.php b/lang/en/block_theme_selector.php
@@ -17,8 +17,7 @@
 /**
  * Theme selector block.
  *
- * @package    block
- * @subpackage theme_selector
+ * @package    block_theme_selector
  * @copyright  &copy; 2015-onwards G J Barnard in respect to modifications of original code:
  *             https://github.com/johntron/moodle-theme-selector-block by John Tron, see:
  *             https://github.com/johntron/moodle-theme-selector-block/issues/1.

diff --git a/settings.php b/settings.php
@@ -17,8 +17,7 @@
 /**
  * Theme selector block.
  *
- * @package    block
- * @subpackage theme_selector
+ * @package    block_theme_selector
  * @copyright  &copy; 2015-onwards G J Barnard in respect to modifications of original code:
  *             https://github.com/johntron/moodle-theme-selector-block by John Tron, see:
  *             https://github.com/johntron/moodle-theme-selector-block/issues/1.

diff --git a/version.php b/version.php
@@ -17,8 +17,7 @@
 /**
  * Theme selector block.
  *
- * @package    block
- * @subpackage theme_selector
+ * @package    block_theme_selector
  * @copyright  &copy; 2015-onwards G J Barnard in respect to modifications of original code:
  *             https://github.com/johntron/moodle-theme-selector-block by John Tron, see:
  *             https://github.com/johntron/moodle-theme-selector-block/issues/1.