MDL-21249 improved php docs package+subpackage info in mod/lesson

This commit is contained in:
Petr Skoda 2010-07-25 10:54:39 +00:00
parent 21b8089c8b
commit cc3dbaaa30
45 changed files with 198 additions and 153 deletions

View file

@ -18,7 +18,8 @@
/** /**
* This file contains the backup task for the lesson module * This file contains the backup task for the lesson module
* *
* @package moodlecore * @package mod
* @subpackage lesson
* @copyright 2010 Sam Hemelryk * @copyright 2010 Sam Hemelryk
* @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
*/ */

View file

@ -49,7 +49,8 @@
* UL->user level info * UL->user level info
* files->table may have files) * files->table may have files)
* *
* @package moodlecore * @package mod
* @subpackage lesson
* @copyright 2010 Sam Hemelryk * @copyright 2010 Sam Hemelryk
* @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
*/ */

View file

@ -18,7 +18,8 @@
/** /**
* Lesson's backup routine * Lesson's backup routine
* *
* @package lesson * @package mod
* @subpackage lesson
* @copyright 1999 onwards Martin Dougiamas {@link http://moodle.com} * @copyright 1999 onwards Martin Dougiamas {@link http://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
**/ **/

View file

@ -18,7 +18,8 @@
/** /**
* Action for processing page answers by users * Action for processing page answers by users
* *
* @package lesson * @package mod
* @subpackage lesson
* @copyright 2009 Sam Hemelryk * @copyright 2009 Sam Hemelryk
* @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
**/ **/

View file

@ -20,7 +20,8 @@
* *
* For naming conventions, see lib/db/access.php. * For naming conventions, see lib/db/access.php.
* *
* @package lesson * @package mod
* @subpackage lesson
* @copyright 1999 onwards Martin Dougiamas {@link http://moodle.com} * @copyright 1999 onwards Martin Dougiamas {@link http://moodle.com}
* @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or late * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or late
*/ */

View file

@ -21,7 +21,8 @@
* * lib.php/modulename_install() post installation hook * * lib.php/modulename_install() post installation hook
* * partially defaults.php * * partially defaults.php
* *
* @package lesson * @package mod
* @subpackage lesson
* @copyright 1999 onwards Martin Dougiamas {@link http://moodle.com} * @copyright 1999 onwards Martin Dougiamas {@link http://moodle.com}
* @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 o * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 o
*/ */

View file

@ -36,7 +36,8 @@
* Please do not forget to use upgrade_set_timeout() * Please do not forget to use upgrade_set_timeout()
* before any action that may take longer time to finish. * before any action that may take longer time to finish.
* *
* @package lesson * @package mod
* @subpackage lesson
* @copyright 1999 onwards Martin Dougiamas {@link http://moodle.com} * @copyright 1999 onwards Martin Dougiamas {@link http://moodle.com}
* @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 o * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 o
*/ */

View file

@ -18,7 +18,8 @@
/** /**
* Provides the interface for overall authoring of lessons * Provides the interface for overall authoring of lessons
* *
* @package lesson * @package mod
* @subpackage lesson
* @copyright 1999 onwards Martin Dougiamas {@link http://moodle.com} * @copyright 1999 onwards Martin Dougiamas {@link http://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
**/ **/

View file

@ -18,7 +18,8 @@
/** /**
* Action for adding a question page. Prints an HTML form. * Action for adding a question page. Prints an HTML form.
* *
* @package lesson * @package mod
* @subpackage lesson
* @copyright 2009 Sam Hemelryk * @copyright 2009 Sam Hemelryk
* @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
**/ **/

View file

@ -18,7 +18,8 @@
/** /**
* Generic forms used for page selection * Generic forms used for page selection
* *
* @package lesson * @package mod
* @subpackage lesson
* @copyright 2009 Sam Hemelryk * @copyright 2009 Sam Hemelryk
* @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
**/ **/

View file

@ -18,7 +18,8 @@
/** /**
* Provides the interface for grading essay questions * Provides the interface for grading essay questions
* *
* @package lesson * @package mod
* @subpackage lesson
* @copyright 1999 onwards Martin Dougiamas {@link http://moodle.com} * @copyright 1999 onwards Martin Dougiamas {@link http://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
**/ **/

View file

@ -18,7 +18,8 @@
/** /**
* Essay grading form * Essay grading form
* *
* @package lesson * @package mod
* @subpackage lesson
* @copyright 2009 Sam Hemelryk * @copyright 2009 Sam Hemelryk
* @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
**/ **/

View file

@ -21,7 +21,8 @@
* *
* Included by import.ph * Included by import.ph
* *
* @package lesson * @package mod
* @subpackage lesson
* @copyright 1999 onwards Martin Dougiamas {@link http://moodle.com} * @copyright 1999 onwards Martin Dougiamas {@link http://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
**/ **/

View file

@ -18,7 +18,8 @@
/** /**
* Grade.php * Grade.php
* *
* @package lesson * @package mod
* @subpackage lesson
* @copyright 1999 onwards Martin Dougiamas {@link http://moodle.com} * @copyright 1999 onwards Martin Dougiamas {@link http://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
**/ **/

View file

@ -18,7 +18,8 @@
/** /**
* Provides the interface for viewing and adding high scores * Provides the interface for viewing and adding high scores
* *
* @package lesson * @package mod
* @subpackage lesson
* @copyright 1999 onwards Martin Dougiamas {@link http://moodle.com} * @copyright 1999 onwards Martin Dougiamas {@link http://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
**/ **/

View file

@ -18,7 +18,8 @@
/** /**
* Imports lesson pages * Imports lesson pages
* *
* @package lesson * @package mod
* @subpackage lesson
* @copyright 1999 onwards Martin Dougiamas {@link http://moodle.com} * @copyright 1999 onwards Martin Dougiamas {@link http://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
**/ **/

View file

@ -18,7 +18,8 @@
/** /**
* Form used to select a file and file format for the import * Form used to select a file and file format for the import
* *
* @package lesson * @package mod
* @subpackage lesson
* @copyright 2009 Sam Hemelryk * @copyright 2009 Sam Hemelryk
* @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
**/ **/

View file

@ -24,7 +24,8 @@
* *
* The script supports book and lesson. * The script supports book and lesson.
* *
* @package lesson * @package mod
* @subpackage lesson
* @copyright 1999 onwards Martin Dougiamas {@link http://moodle.com} * @copyright 1999 onwards Martin Dougiamas {@link http://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
**/ **/

View file

@ -19,7 +19,8 @@
* Contains functions used by importppt.php that naturally pertain to importing * Contains functions used by importppt.php that naturally pertain to importing
* powerpoint presentations into the lesson module * powerpoint presentations into the lesson module
* *
* @package lesson * @package mod
* @subpackage lesson
* @copyright 2009 Sam Hemelryk * @copyright 2009 Sam Hemelryk
* @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
**/ **/

View file

@ -18,7 +18,8 @@
/** /**
* This page lists all the instances of lesson in a particular course * This page lists all the instances of lesson in a particular course
* *
* @package lesson * @package mod
* @subpackage lesson
* @copyright 1999 onwards Martin Dougiamas {@link http://moodle.com} * @copyright 1999 onwards Martin Dougiamas {@link http://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
**/ **/

View file

@ -18,7 +18,8 @@
/** /**
* Strings for component 'lesson', language 'en', branch 'MOODLE_20_STABLE' * Strings for component 'lesson', language 'en', branch 'MOODLE_20_STABLE'
* *
* @package lesson * @package mod
* @subpackage lesson
* @copyright 1999 onwards Martin Dougiamas {@link http://moodle.com} * @copyright 1999 onwards Martin Dougiamas {@link http://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
*/ */

View file

@ -23,7 +23,8 @@
* delete * delete
* move * move
* moveit * moveit
* @package lesson * @package mod
* @subpackage lesson
* @copyright 1999 onwards Martin Dougiamas {@link http://moodle.com} * @copyright 1999 onwards Martin Dougiamas {@link http://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
**/ **/

View file

@ -18,7 +18,8 @@
/** /**
* Standard library of functions and constants for lesson * Standard library of functions and constants for lesson
* *
* @package lesson * @package mod
* @subpackage lesson
* @copyright 1999 onwards Martin Dougiamas {@link http://moodle.com} * @copyright 1999 onwards Martin Dougiamas {@link http://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
**/ **/

View file

@ -19,7 +19,8 @@
* Local library file for Lesson. These are non-standard functions that are used * Local library file for Lesson. These are non-standard functions that are used
* only by Lesson. * only by Lesson.
* *
* @package lesson * @package mod
* @subpackage lesson
* @copyright 1999 onwards Martin Dougiamas {@link http://moodle.com} * @copyright 1999 onwards Martin Dougiamas {@link http://moodle.com}
* @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or late * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or late
**/ **/

View file

@ -21,7 +21,8 @@
* If there is a way to use the resource class instead of this code, please change to do so * If there is a way to use the resource class instead of this code, please change to do so
* *
* *
* @package lesson * @package mod
* @subpackage lesson
* @copyright 1999 onwards Martin Dougiamas {@link http://moodle.com} * @copyright 1999 onwards Martin Dougiamas {@link http://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
**/ **/

View file

@ -19,7 +19,8 @@
* Form to define a new instance of lesson or edit an instance. * Form to define a new instance of lesson or edit an instance.
* It is used from /course/modedit.php. * It is used from /course/modedit.php.
* *
* @package lesson * @package mod
* @subpackage lesson
* @copyright 1999 onwards Martin Dougiamas {@link http://moodle.com} * @copyright 1999 onwards Martin Dougiamas {@link http://moodle.com}
* @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or late * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or late
**/ **/

View file

@ -18,7 +18,8 @@
/** /**
* Branch Table * Branch Table
* *
* @package lesson * @package mod
* @subpackage lesson
* @copyright 2009 Sam Hemelryk * @copyright 2009 Sam Hemelryk
* @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
**/ **/

View file

@ -18,7 +18,8 @@
/** /**
* Cluster * Cluster
* *
* @package lesson * @package mod
* @subpackage lesson
* @copyright 2009 Sam Hemelryk * @copyright 2009 Sam Hemelryk
* @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
**/ **/

View file

@ -18,7 +18,8 @@
/** /**
* End of branch table * End of branch table
* *
* @package lesson * @package mod
* @subpackage lesson
* @copyright 2009 Sam Hemelryk * @copyright 2009 Sam Hemelryk
* @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
**/ **/

View file

@ -18,7 +18,8 @@
/** /**
* End of cluster * End of cluster
* *
* @package lesson * @package mod
* @subpackage lesson
* @copyright 2009 Sam Hemelryk * @copyright 2009 Sam Hemelryk
* @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
**/ **/

View file

@ -18,7 +18,8 @@
/** /**
* Essay * Essay
* *
* @package lesson * @package mod
* @subpackage lesson
* @copyright 2009 Sam Hemelryk * @copyright 2009 Sam Hemelryk
* @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
**/ **/

View file

@ -18,7 +18,8 @@
/** /**
* Matching * Matching
* *
* @package lesson * @package mod
* @subpackage lesson
* @copyright 2009 Sam Hemelryk * @copyright 2009 Sam Hemelryk
* @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
**/ **/

View file

@ -18,7 +18,8 @@
/** /**
* Multichoice * Multichoice
* *
* @package lesson * @package mod
* @subpackage lesson
* @copyright 2009 Sam Hemelryk * @copyright 2009 Sam Hemelryk
* @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
**/ **/

View file

@ -18,7 +18,8 @@
/** /**
* Numerical * Numerical
* *
* @package lesson * @package mod
* @subpackage lesson
* @copyright 2009 Sam Hemelryk * @copyright 2009 Sam Hemelryk
* @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
**/ **/

View file

@ -18,7 +18,8 @@
/** /**
* Short answer * Short answer
* *
* @package lesson * @package mod
* @subpackage lesson
* @copyright 2009 Sam Hemelryk * @copyright 2009 Sam Hemelryk
* @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
**/ **/

View file

@ -18,7 +18,8 @@
/** /**
* True/false * True/false
* *
* @package lesson * @package mod
* @subpackage lesson
* @copyright 2009 Sam Hemelryk * @copyright 2009 Sam Hemelryk
* @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
**/ **/

View file

@ -18,7 +18,8 @@
/** /**
* jjg7:8/9/2004 * jjg7:8/9/2004
* *
* @package lesson * @package mod
* @subpackage lesson
* @copyright 1999 onwards Martin Dougiamas {@link http://moodle.com} * @copyright 1999 onwards Martin Dougiamas {@link http://moodle.com}
* @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or late * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or late
**/ **/

View file

@ -18,7 +18,8 @@
/** /**
* Moodle renderer used to display special elements of the lesson module * Moodle renderer used to display special elements of the lesson module
* *
* @package lesson * @package mod
* @subpackage lesson
* @copyright 2009 Sam Hemelryk * @copyright 2009 Sam Hemelryk
* @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
**/ **/

View file

@ -18,7 +18,8 @@
/** /**
* Displays the lesson statistics. * Displays the lesson statistics.
* *
* @package lesson * @package mod
* @subpackage lesson
* @copyright 1999 onwards Martin Dougiamas {@link http://moodle.com} * @copyright 1999 onwards Martin Dougiamas {@link http://moodle.com}
* @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or late * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or late
**/ **/

View file

@ -18,7 +18,8 @@
/** /**
* This php script contains all the stuff to restore lesson mods * This php script contains all the stuff to restore lesson mods
* *
* @package lesson * @package mod
* @subpackage lesson
* @copyright 1999 onwards Martin Dougiamas {@link http://moodle.com} * @copyright 1999 onwards Martin Dougiamas {@link http://moodle.com}
* @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or late * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or late
**/ **/

View file

@ -18,7 +18,8 @@
/** /**
* Settings used by the lesson module, were moved from mod_edit * Settings used by the lesson module, were moved from mod_edit
* *
* @package lesson * @package mod
* @subpackage lesson
* @copyright 2009 Sam Hemelryk * @copyright 2009 Sam Hemelryk
* @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or late * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or late
**/ **/

View file

@ -20,7 +20,8 @@
* *
* This file was adapted from the mod/quiz/tabs.php * This file was adapted from the mod/quiz/tabs.php
* *
* @package lesson * @package mod
* @subpackage lesson
* @copyright 1999 onwards Martin Dougiamas {@link http://moodle.com} * @copyright 1999 onwards Martin Dougiamas {@link http://moodle.com}
* @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or late * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or late
*/ */

View file

@ -19,7 +19,8 @@
* Code fragment to define the version of lesson * Code fragment to define the version of lesson
* This fragment is called by moodle_needs_upgrading() and /admin/index.php * This fragment is called by moodle_needs_upgrading() and /admin/index.php
* *
* @package lesson * @package mod
* @subpackage lesson
* @copyright 1999 onwards Martin Dougiamas {@link http://moodle.com} * @copyright 1999 onwards Martin Dougiamas {@link http://moodle.com}
* @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or late * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or late
**/ **/

View file

@ -18,7 +18,8 @@
/** /**
* This page prints a particular instance of lesson * This page prints a particular instance of lesson
* *
* @package lesson * @package mod
* @subpackage lesson
* @copyright 1999 onwards Martin Dougiamas {@link http://moodle.com} * @copyright 1999 onwards Martin Dougiamas {@link http://moodle.com}
* @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or late * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or late
**/ **/

View file

@ -18,7 +18,8 @@
/** /**
* Lesson page without answers * Lesson page without answers
* *
* @package lesson * @package mod
* @subpackage lesson
* @copyright 2009 Sam Hemelryk * @copyright 2009 Sam Hemelryk
* @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
**/ **/