From 5491947aa1cd05378be005c29bb07233e391ec2b Mon Sep 17 00:00:00 2001
From: mark-nielsen <mark-nielsen>
Date: Sat, 30 Sep 2006 19:49:40 +0000
Subject: [PATCH] NO CODE CHANGES.  Just added PHPdoc comments at the top of
 lesson files.

---
 mod/lesson/action/addcluster.php      | 10 +++++--
 mod/lesson/action/addendofbranch.php  | 10 +++++--
 mod/lesson/action/addendofcluster.php | 10 +++++--
 mod/lesson/action/confirmdelete.php   | 10 +++++--
 mod/lesson/action/continue.php        | 10 +++++--
 mod/lesson/action/delete.php          |  9 ++++--
 mod/lesson/action/insertpage.php      | 10 +++++--
 mod/lesson/action/move.php            |  9 ++++--
 mod/lesson/action/moveit.php          | 10 +++++--
 mod/lesson/action/updatepage.php      | 10 +++++--
 mod/lesson/backuplib.php              | 13 +++++----
 mod/lesson/format.php                 | 16 +++++-----
 mod/lesson/import.php                 | 10 +++++--
 mod/lesson/importppt.php              | 22 +++++++++-----
 mod/lesson/index.php                  | 11 +++++--
 mod/lesson/lesson.php                 | 42 ++++++++++++++-------------
 mod/lesson/lib.php                    | 17 +++++------
 mod/lesson/locallib.php               | 11 +++++--
 mod/lesson/mediafile.php              | 18 ++++++++----
 mod/lesson/mod.html                   | 13 +++++++--
 mod/lesson/reformat.php               | 11 +++++--
 mod/lesson/restorelib.php             | 12 +++++---
 mod/lesson/version.php                | 15 ++++++----
 23 files changed, 204 insertions(+), 105 deletions(-)

diff --git a/mod/lesson/action/addcluster.php b/mod/lesson/action/addcluster.php
index e3148baea0..baf5aa0b6a 100644
--- a/mod/lesson/action/addcluster.php
+++ b/mod/lesson/action/addcluster.php
@@ -1,7 +1,11 @@
 <?php // $Id$
-
-/************** add cluster ************************************/
-
+/**
+ * Action for adding a cluster page
+ *
+ * @version $Id$
+ * @license http://www.gnu.org/copyleft/gpl.html GNU Public License
+ * @package lesson
+ **/
     confirm_sesskey();
 
     // first get the preceeding page
diff --git a/mod/lesson/action/addendofbranch.php b/mod/lesson/action/addendofbranch.php
index 5341071a12..5decb9f2f9 100644
--- a/mod/lesson/action/addendofbranch.php
+++ b/mod/lesson/action/addendofbranch.php
@@ -1,7 +1,11 @@
 <?php // $Id$
-
-/************** add end of branch ************************************/
-
+/**
+ * Action for adding an end of branch page
+ *
+ * @version $Id$
+ * @license http://www.gnu.org/copyleft/gpl.html GNU Public License
+ * @package lesson
+ **/
     confirm_sesskey();
 
     // first get the preceeding page
diff --git a/mod/lesson/action/addendofcluster.php b/mod/lesson/action/addendofcluster.php
index dc05fa7093..be1d261d9f 100644
--- a/mod/lesson/action/addendofcluster.php
+++ b/mod/lesson/action/addendofcluster.php
@@ -1,7 +1,11 @@
 <?php // $Id$
-
-/************** add end of cluster ************************************/
-
+/**
+ * Action for adding an end of cluster page
+ *
+ * @version $Id$
+ * @license http://www.gnu.org/copyleft/gpl.html GNU Public License
+ * @package lesson
+ **/
     confirm_sesskey();
 
     // first get the preceeding page
diff --git a/mod/lesson/action/confirmdelete.php b/mod/lesson/action/confirmdelete.php
index 38c737e35f..a1f2a3a75d 100644
--- a/mod/lesson/action/confirmdelete.php
+++ b/mod/lesson/action/confirmdelete.php
@@ -1,7 +1,11 @@
 <?php // $Id$
-
-/******************* confirm delete ************************************/
-
+/**
+ * Action for confirming the deletion of a page
+ *
+ * @version $Id$
+ * @license http://www.gnu.org/copyleft/gpl.html GNU Public License
+ * @package lesson
+ **/
     confirm_sesskey();
 
     $pageid = required_param('pageid', PARAM_INT);
diff --git a/mod/lesson/action/continue.php b/mod/lesson/action/continue.php
index ab54ea37da..d8470eb15c 100644
--- a/mod/lesson/action/continue.php
+++ b/mod/lesson/action/continue.php
@@ -1,7 +1,11 @@
 <?php // $Id$
-
-/****************** continue ************************************/
-
+/**
+ * Action for processing page answers by users
+ *
+ * @version $Id$
+ * @license http://www.gnu.org/copyleft/gpl.html GNU Public License
+ * @package lesson
+ **/
     confirm_sesskey();
 
     // left menu code
diff --git a/mod/lesson/action/delete.php b/mod/lesson/action/delete.php
index 3ac6702de9..48aa1a8437 100644
--- a/mod/lesson/action/delete.php
+++ b/mod/lesson/action/delete.php
@@ -1,6 +1,11 @@
 <?php // $Id$
-
-/******************* delete ************************************/
+/**
+ * Action for deleting a page
+ *
+ * @version $Id$
+ * @license http://www.gnu.org/copyleft/gpl.html GNU Public License
+ * @package lesson
+ **/
     confirm_sesskey();
 
     $pageid = required_param('pageid', PARAM_INT);
diff --git a/mod/lesson/action/insertpage.php b/mod/lesson/action/insertpage.php
index b377c9bcce..e4217dd73e 100644
--- a/mod/lesson/action/insertpage.php
+++ b/mod/lesson/action/insertpage.php
@@ -1,7 +1,11 @@
 <?php // $Id$
-
-/****************** insert page ************************************/
-        
+/**
+ * Action for processing the form from addpage action and inserts the page.
+ *
+ * @version $Id$
+ * @license http://www.gnu.org/copyleft/gpl.html GNU Public License
+ * @package lesson
+ **/
     confirm_sesskey();
 
     // check to see if the cancel button was pushed
diff --git a/mod/lesson/action/move.php b/mod/lesson/action/move.php
index 832ef2d3f3..fb296e7530 100644
--- a/mod/lesson/action/move.php
+++ b/mod/lesson/action/move.php
@@ -1,6 +1,11 @@
 <?php // $Id$
-
-/****************** move ************************************/
+/**
+ * Action that displays an interface for moving a page
+ *
+ * @version $Id$
+ * @license http://www.gnu.org/copyleft/gpl.html GNU Public License
+ * @package lesson
+ **/
    
     $pageid = required_param('pageid', PARAM_INT);
     $title = get_field("lesson_pages", "title", "id", $pageid);
diff --git a/mod/lesson/action/moveit.php b/mod/lesson/action/moveit.php
index abc5258e57..2e2d095916 100644
--- a/mod/lesson/action/moveit.php
+++ b/mod/lesson/action/moveit.php
@@ -1,7 +1,11 @@
 <?php // $Id$
-
-/****************** moveit ************************************/
-   
+/**
+ * Action for actually moving the page (database changes)
+ *
+ * @version $Id$
+ * @license http://www.gnu.org/copyleft/gpl.html GNU Public License
+ * @package lesson
+ **/
     confirm_sesskey();
 
     $pageid = required_param('pageid', PARAM_INT); //  page to move
diff --git a/mod/lesson/action/updatepage.php b/mod/lesson/action/updatepage.php
index f1df47d6bb..d54e179f62 100644
--- a/mod/lesson/action/updatepage.php
+++ b/mod/lesson/action/updatepage.php
@@ -1,7 +1,11 @@
 <?php // $Id$
-
-/****************** update page ************************************/
-    
+/**
+ * Action for processing the form in editpage action and saves the page
+ *
+ * @version $Id$
+ * @license http://www.gnu.org/copyleft/gpl.html GNU Public License
+ * @package lesson
+ **/
     confirm_sesskey();
     
     $redirect = optional_param('redirect', '', PARAM_ALPHA);
diff --git a/mod/lesson/backuplib.php b/mod/lesson/backuplib.php
index bd5498b085..a7259d840f 100644
--- a/mod/lesson/backuplib.php
+++ b/mod/lesson/backuplib.php
@@ -1,8 +1,11 @@
-<?PHP //$Id$
-
-    //This php script contains all the stuff to backup/restore
-    //lesson mods
-
+<?php //$Id$
+/**
+ * Lesson's backup routine
+ *
+ * @version $Id$
+ * @license http://www.gnu.org/copyleft/gpl.html GNU Public License
+ * @package lesson
+ **/
     //This is the "graphical" structure of the lesson mod: 
     //
     //          lesson_default                  lesson ----------------------------|--------------------------|--------------------------|
diff --git a/mod/lesson/format.php b/mod/lesson/format.php
index c26aad2f85..c547c7b01f 100644
--- a/mod/lesson/format.php
+++ b/mod/lesson/format.php
@@ -1,10 +1,12 @@
-<?PHP  // $Id$ 
-
-////////////////////////////////////////////////////////////////////
-/// format.php  - Default format class for file imports/exports.  //
-///                                                               //
-/// Doesn't do everything on it's own -- it needs to be extended. //
-////////////////////////////////////////////////////////////////////
+<?php  // $Id$ 
+/**
+ * format.php  - Default format class for file imports/exports. Doesn't do 
+ * everything on it's own -- it needs to be extended.
+ *
+ * @version $Id$
+ * @license http://www.gnu.org/copyleft/gpl.html GNU Public License
+ * @package lesson
+ **/
 
 // Included by import.php
 
diff --git a/mod/lesson/import.php b/mod/lesson/import.php
index a5fd6e812c..e40108aef0 100644
--- a/mod/lesson/import.php
+++ b/mod/lesson/import.php
@@ -1,5 +1,11 @@
-<?PHP // $Id$
-      // Import quiz questions into the given category
+<?php // $Id$
+/**
+ * Imports lesson pages
+ *
+ * @version $Id$
+ * @license http://www.gnu.org/copyleft/gpl.html GNU Public License
+ * @package lesson
+ **/
 
     require_once("../../config.php");
     require_once("lib.php");
diff --git a/mod/lesson/importppt.php b/mod/lesson/importppt.php
index 758b83c730..42fbd62067 100644
--- a/mod/lesson/importppt.php
+++ b/mod/lesson/importppt.php
@@ -1,11 +1,17 @@
-<?php   
-    //This is a very rough importer for powerpoint slides
-    //Export a powerpoint presentation with powerpoint as html pages
-    //Do it with office 2002 (I think?) and no special settings
-    //Then zip the directory with all of the html pages 
-    //and the zip file is what you want to upload
-    
-    // supports book and lesson
+<?php // $Id$
+/**
+ * This is a very rough importer for powerpoint slides
+ * Export a powerpoint presentation with powerpoint as html pages
+ * Do it with office 2002 (I think?) and no special settings
+ * Then zip the directory with all of the html pages 
+ * and the zip file is what you want to upload
+ * 
+ * The script supports book and lesson.
+ *
+ * @version $Id$
+ * @license http://www.gnu.org/copyleft/gpl.html GNU Public License
+ * @package lesson
+ **/
 
     require_once("../../config.php");
     require_once("locallib.php");
diff --git a/mod/lesson/index.php b/mod/lesson/index.php
index e354cc5297..70d8c378a7 100644
--- a/mod/lesson/index.php
+++ b/mod/lesson/index.php
@@ -1,6 +1,11 @@
-<?PHP // $Id$
-
-/// This page lists all the instances of lesson in a particular course
+<?php // $Id$
+/**
+ * This page lists all the instances of lesson in a particular course
+ *
+ * @version $Id$
+ * @license http://www.gnu.org/copyleft/gpl.html GNU Public License
+ * @package lesson
+ **/
 
     require_once("../../config.php");
     require_once("locallib.php");
diff --git a/mod/lesson/lesson.php b/mod/lesson/lesson.php
index e0cf6b0232..902bae5b20 100644
--- a/mod/lesson/lesson.php
+++ b/mod/lesson/lesson.php
@@ -1,23 +1,25 @@
-<?PHP  // $Id: lesson.php, v 1.0 25 Jan 2004
-
-/*************************************************
-    ACTIONS handled are:
-
-    addbranchtable
-    addendofbranch
-    addcluster
-    addendofcluster
-    addpage
-    confirmdelete
-    continue
-    delete
-    editpage
-    insertpage
-    move
-    moveit
-    updatepage
-
-************************************************/
+<?php  // $Id: lesson.php, v 1.0 25 Jan 2004
+/**
+ * Handles lesson actions
+ * 
+ * ACTIONS handled are:
+ *    addbranchtable
+ *    addendofbranch
+ *    addcluster
+ *    addendofcluster
+ *    addpage
+ *    confirmdelete
+ *    continue
+ *    delete
+ *    editpage
+ *    insertpage
+ *    move
+ *    moveit
+ *    updatepage
+ * @version $Id$
+ * @license http://www.gnu.org/copyleft/gpl.html GNU Public License
+ * @package lesson
+ **/
 
     require("../../config.php");
     require("locallib.php");
diff --git a/mod/lesson/lib.php b/mod/lesson/lib.php
index db8ddd67a6..7b700cd326 100644
--- a/mod/lesson/lib.php
+++ b/mod/lesson/lib.php
@@ -1,15 +1,14 @@
-<?PHP  // $Id$ 
-        // modified by mnielsen
-        /// Update:  The lib.php now contains only the functions that are
-        /// used outside of the lesson module.  All functions (I hope) that are only local
-        /// are now in locallib.php.
-
-/// Library of functions and constants for module lesson
+<?php  // $Id$
+/**
+ * Standard library of functions and constants for lesson
+ *
+ * @version $Id$
+ * @license http://www.gnu.org/copyleft/gpl.html GNU Public License
+ * @package lesson
+ **/
 
 define("LESSON_MAX_EVENT_LENGTH", "432000");   // 5 days maximum
 
-/// (replace lesson with the name of your module and delete this line)
-
 /*******************************************************************/
 function lesson_add_instance($lesson) {
 /// Given an object containing all the necessary data, 
diff --git a/mod/lesson/locallib.php b/mod/lesson/locallib.php
index 11c13e44ef..af6a83e3e0 100644
--- a/mod/lesson/locallib.php
+++ b/mod/lesson/locallib.php
@@ -1,7 +1,12 @@
 <?php // $Id$
-/// mnielsen
-/// locallib.php is the new lib file for lesson module.
-/// including locallib.php is the same as including the old lib.php
+/**
+ * Local library file for Lesson.  These are non-standard functions that are used
+ * only by Lesson.
+ *
+ * @version $Id$
+ * @license http://www.gnu.org/copyleft/gpl.html GNU Public License
+ * @package lesson
+ **/
 
 /**
 * Next page -> any page not seen before
diff --git a/mod/lesson/mediafile.php b/mod/lesson/mediafile.php
index 31120db237..d8183006b5 100644
--- a/mod/lesson/mediafile.php
+++ b/mod/lesson/mediafile.php
@@ -1,8 +1,16 @@
-<?php
-    // This file plays the mediafile set in lesson settings
-    // Almost all of this code is from /mod/resource/type/file/resource.class.php so major props for resource
-    // If there is a way to use the resource class instead of this code, please change to do so
-    // because I could not figure it out
+<?php  // $Id$
+/**
+ * This file plays the mediafile set in lesson settings.
+ *
+ * Almost all of this code is from /mod/resource/type/file/resource.class.php so major props for resource
+ *
+ *  If there is a way to use the resource class instead of this code, please change to do so
+ *
+ *
+ * @version $Id$
+ * @license http://www.gnu.org/copyleft/gpl.html GNU Public License
+ * @package lesson
+ **/
 
     require_once('../../config.php');
     require_once($CFG->libdir.'/filelib.php');
diff --git a/mod/lesson/mod.html b/mod/lesson/mod.html
index edf1a8872c..165015e100 100644
--- a/mod/lesson/mod.html
+++ b/mod/lesson/mod.html
@@ -1,6 +1,13 @@
-<!-- define a new instance of lesson -->
-<!-- It is used from /course/mod.php.  The whole instance is available as $form. -->
-<?php
+<?php  // $Id$
+/**
+ * Define a new instance of lesson or edit an instance.
+ * It is used from /course/mod.php.  The whole instance is available as $form.
+ * 
+ * @version $Id$
+ * @license http://www.gnu.org/copyleft/gpl.html GNU Public License
+ * @package lesson
+ **/
+
 require("$CFG->dirroot/mod/lesson/locallib.php");  // for parameter array
 if ($form->mode == "add") {
     if ($defaults = get_record("lesson_default", "course", $form->course)) {
diff --git a/mod/lesson/reformat.php b/mod/lesson/reformat.php
index 8501c7e145..9382ffc8e9 100644
--- a/mod/lesson/reformat.php
+++ b/mod/lesson/reformat.php
@@ -1,5 +1,12 @@
-<?php 
-// jjg7:8/9/2004
+<?php // $Id$
+/**
+ * jjg7:8/9/2004
+ *
+ * @version $Id$
+ * @license http://www.gnu.org/copyleft/gpl.html GNU Public License
+ * @package lesson
+ **/
+
 function removedoublecr($filename) {
 // This function will adjust a file in roughly Aiken style by replacing extra newlines with <BR> tags
 // so that instructors can have newlines wherever they like as long as the overall format is in Aiken
diff --git a/mod/lesson/restorelib.php b/mod/lesson/restorelib.php
index 0b418f8431..f7db37dcf6 100644
--- a/mod/lesson/restorelib.php
+++ b/mod/lesson/restorelib.php
@@ -1,7 +1,11 @@
-<?PHP //$Id$
-
-    //This php script contains all the stuff to backup/restore
-    //lesson mods
+<?php //$Id$
+/**
+ * This php script contains all the stuff to restore lesson mods
+ *
+ * @version $Id$
+ * @license http://www.gnu.org/copyleft/gpl.html GNU Public License
+ * @package lesson
+ **/
 
     //This is the "graphical" structure of the lesson mod: 
     //
diff --git a/mod/lesson/version.php b/mod/lesson/version.php
index b722ead2df..8041ba59d4 100644
--- a/mod/lesson/version.php
+++ b/mod/lesson/version.php
@@ -1,9 +1,12 @@
-<?PHP // $Id$
-
-/////////////////////////////////////////////////////////////////////////////////
-///  Code fragment to define the version of lesson
-///  This fragment is called by moodle_needs_upgrading() and /admin/index.php
-/////////////////////////////////////////////////////////////////////////////////
+<?php // $Id$
+/**
+ * Code fragment to define the version of lesson
+ * This fragment is called by moodle_needs_upgrading() and /admin/index.php
+ *
+ * @version $Id$
+ * @license http://www.gnu.org/copyleft/gpl.html GNU Public License
+ * @package lesson
+ **/
 
 $module->version  = 2006091801;  // The current module version (Date: YYYYMMDDXX)
 $module->requires = 2006080900;  // Requires this Moodle version
-- 
2.39.5