MDL-30982 Activity module stepslib - API documentation

backup/moodle2/backup_stepslib.php

@@ -99,6 +99,7 @@ abstract class backup_activity_structure_step extends backup_structure_step {
      *                                       we are going to add subplugin information to
      * @param bool $multiple to define if multiple subplugins can produce information
      *                       for each instance of $element (true) or no (false)
+     * @return void
      */
     protected function add_subplugin_structure($subplugintype, $element, $multiple) {
 
@@ -136,6 +137,8 @@ protected function add_subplugin_structure($subplugintype, $element, $multiple)
     /**
      * As far as activity backup steps are implementing backup_subplugin stuff, they need to
      * have the parent task available for wrapping purposes (get course/context....)
+     *
+     * @return backup_activity_task
      */
     public function get_task() {
         return $this->task;
@@ -144,6 +147,9 @@ public function get_task() {
     /**
      * Wraps any activity backup structure within the common 'activity' element
      * that will include common to all activities information like id, context...
+     *
+     * @param backup_nested_element $activitystructure the element to wrap
+     * @return backup_nested_element the $activitystructure wrapped by the common 'activity' element
      */
     protected function prepare_activity_structure($activitystructure) {
 

mod/workshop/backup/moodle2/backup_workshop_stepslib.php

@@ -18,21 +18,26 @@
 /**
  * Defines all the backup steps that will be used by {@link backup_workshop_activity_task}
  *
- * @package    mod
- * @subpackage workshop
- * @copyright  2010 David Mudrak <[email protected]>
- * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
+ * @package     mod_workshop
+ * @category    backup
+ * @copyright   2010 David Mudrak <[email protected]>
+ * @license     http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
  */
 
 defined('MOODLE_INTERNAL') || die();
 
 /**
  * Defines the complete workshop structure for backup, with file and id annotations
  *
- * @see http://docs.moodle.org/dev/Workshop for XML structure diagram
+ * @link http://docs.moodle.org/dev/Workshop for XML structure diagram
  */
 class backup_workshop_activity_structure_step extends backup_activity_structure_step {
 
+    /**
+     * Defines the structure of the 'workshop' element inside the workshop.xml file
+     *
+     * @return backup_nested_element
+     */
     protected function define_structure() {
 
         // are we including userinfo?