MDL-30998: updated docblocks for backup of advanced grading

moodle · Jan 14, 2013 · fa4c60c · fa4c60c
1 parent ca48fe5
commit fa4c60c
Show file tree

Hide file tree

Showing 2 changed files with 20 additions and 11 deletions.
diff --git a/backup/moodle2/backup_gradingform_plugin.class.php b/backup/moodle2/backup_gradingform_plugin.class.php
@@ -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
@@ -16,19 +15,24 @@
 // along with Moodle.  If not, see <http://www.gnu.org/licenses/>.
 
 /**
- * Defines backup_gradingform_plugin class
+ * Contains class backup_gradingform_plugin responsible for advanced grading form plugin backup
  *
  * @package     core_backup
  * @subpackage  moodle2
- * @category    backup
  * @copyright   2011 David Mudrak <david@moodle.com>
  * @license     http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
  */
 
 defined('MOODLE_INTERNAL') || die();
 
 /**
- * Base class for all advanced grading form plugins
+ * Base class for backup all advanced grading form plugins
+ *
+ * As an example of implementation see {@link backup_gradingform_rubric_plugin}
+ *
+ * @copyright  2011 David Mudrak <david@moodle.com>
+ * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
+ * @category   backup
  */
 abstract class backup_gradingform_plugin extends backup_plugin {
 }
diff --git a/backup/moodle2/restore_gradingform_plugin.class.php b/backup/moodle2/restore_gradingform_plugin.class.php
@@ -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
@@ -16,18 +15,24 @@
 // along with Moodle.  If not, see <http://www.gnu.org/licenses/>.
 
 /**
- * Defines restore_gradingform_plugin class
+ * Contains class restore_gradingform_plugin responsible for advanced grading form plugin backup
- * @package     core_backup
+ *
+ * @package    core_backup
  * @subpackage  moodle2
- * @category    backup
+ * @copyright  2011 David Mudrak <david@moodle.com>
- * @copyright   2011 David Mudrak <david@moodle.com>
+ * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
- * @license     http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
  */
 
 defined('MOODLE_INTERNAL') || die();
 
 /**
- * Base class for all advanced grading form plugins
+ * Base class for restoring all advanced grading form plugins
+ *
+ * As an example of implementation see {@link restore_gradingform_rubric_plugin}
+ *
+ * @copyright  2011 David Mudrak <david@moodle.com>
+ * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
+ * @category   backup
  */
 abstract class restore_gradingform_plugin extends restore_plugin {