Update documentation

catalyst · Oct 21, 2024 · 8827b45 · 8827b45
1 parent bd0930b
commit 8827b45
Showing 1 changed file with 7 additions and 2 deletions.
diff --git a/db/upgrade.php b/db/upgrade.php
@@ -14,12 +14,17 @@
 // You should have received a copy of the GNU General Public License
 // along with Moodle.  If not, see <http://www.gnu.org/licenses/>.
 
-/**
- * This file handles database upgrades for tool_lcbackupcoursestep.
+ /**
+ * Upgrade script for tool_lcbackupcoursestep.
  *
+ * This function handles any necessary upgrades to the tool_lcbackupcoursestep plugin.
+ * 
  * @package   tool_lcbackupcoursestep
  * @copyright 2024 Catalyst
  * @license   http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
+ * 
+ * @param int $oldversion The version of the plugin we are upgrading from.
+ * @return bool True if the upgrade was successful.
  */
 
 function xmldb_tool_lcbackupcoursestep_upgrade($oldversion) {