Permalink
Browse files

MDL-30975 Docs Adding correct pacakge information

  • Loading branch information...
1 parent a5fa03e commit 04252d3a13cb61d93c364ea94ec45e66da5058cd @ankitagarwal ankitagarwal committed Jan 6, 2012
View
@@ -22,7 +22,6 @@
* - moodlelib.php - general-purpose Moodle functions
*
* @package core
- * @subpackage lib
* @copyright 1999 onwards Martin Dougiamas {@link http://moodle.com}
* @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
*/
@@ -1648,9 +1647,11 @@ function coursemodule_visible_for_user($cm, $userid=0) {
* than web server hits, and provide a way to easily reconstruct what
* any particular student has been doing.
*
- * @global object $DB
- * @global object $CFG
- * @global object $USER
+ * @package core
+ * @category log
+ * @global moodle_database $DB
+ * @global stdClass $CFG
+ * @global stdClass $USER
* @uses SITEID
* @uses DEBUG_DEVELOPER
* @uses DEBUG_ALL
@@ -1745,9 +1746,11 @@ function add_to_log($courseid, $module, $action, $url='', $info='', $cm=0, $user
/**
* Store user last access times - called when use enters a course or site
*
- * @global object $USER
- * @global object $CFG
- * @global object $DB
+ * @package core
+ * @category log
+ * @global stdClass $USER
+ * @global stdClass $CFG
+ * @global moodle_database $DB
* @uses LASTACCESS_UPDATE_SECS
* @uses SITEID
* @param int $courseid empty courseid means site
@@ -1815,14 +1818,16 @@ function user_accesstime_log($courseid=0) {
/**
* Select all log records based on SQL criteria
*
- * @global object $DB
+ * @package core
+ * @category log
+ * @global moodle_database $DB
* @param string $select SQL select criteria
* @param array $params named sql type params
* @param string $order SQL order by clause to sort the records returned
* @param string $limitfrom return a subset of records, starting at this point (optional, required if $limitnum is set)
* @param int $limitnum return a subset comprising this many records (optional, required if $limitfrom is set)
* @param int $totalcount Passed in by reference.
- * @return moodle_recordset instance
+ * @return array
*/
function get_logs($select, array $params=null, $order='l.time DESC', $limitfrom='', $limitnum='', &$totalcount) {
global $DB;
@@ -1857,12 +1862,14 @@ function get_logs($select, array $params=null, $order='l.time DESC', $limitfrom=
/**
* Select all log records for a given course and user
*
- * @global object $DB
+ * @package core
+ * @category log
+ * @global moodle_database $DB
* @uses DAYSECS
* @param int $userid The id of the user as found in the 'user' table.
* @param int $courseid The id of the course as found in the 'course' table.
* @param string $coursestart unix timestamp representing course start date and time.
- * @return moodle_recordset instance
+ * @return array
*/
function get_logs_usercourse($userid, $courseid, $coursestart) {
global $DB;
@@ -1887,12 +1894,14 @@ function get_logs_usercourse($userid, $courseid, $coursestart) {
/**
* Select all log records for a given course, user, and day
*
- * @global object $DB
+ * @package core
+ * @category log
+ * @global moodle_database $DB
* @uses HOURSECS
* @param int $userid The id of the user as found in the 'user' table.
* @param int $courseid The id of the course as found in the 'course' table.
* @param string $daystart unix timestamp of the start of the day for which the logs needs to be retrived
- * @return moodle_recordset instance
+ * @return array
*/
function get_logs_userday($userid, $courseid, $daystart) {
global $DB;
@@ -1921,7 +1930,7 @@ function get_logs_userday($userid, $courseid, $daystart) {
* number of accounts. For non-admins, only the attempts on the given user
* are shown.
*
- * @global object $DB
+ * @global moodle_database $DB
* @uses CONTEXT_SYSTEM
* @param string $mode Either 'admin' or 'everybody'
* @param string $username The username we are searching for
@@ -18,8 +18,8 @@
/**
* Definition of log events
*
- * @package mod
- * @subpackage assignment
+ * @package mod_assignment
+ * @category log
* @copyright 2010 Petr Skoda (http://skodak.org)
* @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
*/
View
@@ -18,8 +18,8 @@
/**
* Definition of log events
*
- * @package mod
- * @subpackage chat
+ * @package mod_chat
+ * @category log
* @copyright 2010 Petr Skoda (http://skodak.org)
* @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
*/
View
@@ -18,8 +18,8 @@
/**
* Definition of log events
*
- * @package mod
- * @subpackage choice
+ * @package mod_choice
+ * @category log
* @copyright 2010 Petr Skoda (http://skodak.org)
* @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
*/
View
@@ -18,8 +18,8 @@
/**
* Definition of log events
*
- * @package mod
- * @subpackage data
+ * @package mod_data
+ * @category log
* @copyright 2010 Petr Skoda (http://skodak.org)
* @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
*/
View
@@ -17,8 +17,8 @@
/**
* Definition of log events
*
- * @package mod
- * @subpackage feedback
+ * @package mod_feedback
+ * @category log
* @copyright 2010 Petr Skoda (http://skodak.org)
* @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
*/
View
@@ -18,8 +18,8 @@
/**
* Definition of log events
*
- * @package mod
- * @subpackage folder
+ * @package mod_folder
+ * @category log
* @copyright 2010 Petr Skoda (http://skodak.org)
* @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
*/
View
@@ -18,8 +18,8 @@
/**
* Definition of log events
*
- * @package mod
- * @subpackage forum
+ * @package mod_forum
+ * @category log
* @copyright 2010 Petr Skoda (http://skodak.org)
* @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
*/
View
@@ -18,8 +18,8 @@
/**
* Definition of log events
*
- * @package mod
- * @subpackage glossary
+ * @package mod_glossary
+ * @category log
* @copyright 2010 Petr Skoda (http://skodak.org)
* @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
*/
View
@@ -18,8 +18,8 @@
/**
* Definition of log events
*
- * @package mod
- * @subpackage imscp
+ * @package mod_imscp
+ * @category log
* @copyright 2010 Petr Skoda (http://skodak.org)
* @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
*/
View
@@ -18,8 +18,8 @@
/**
* Definition of log events
*
- * @package mod
- * @subpackage label
+ * @package mod_label
+ * @category log
* @copyright 2010 Petr Skoda (http://skodak.org)
* @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
*/
View
@@ -18,8 +18,8 @@
/**
* Definition of log events
*
- * @package mod
- * @subpackage lesson
+ * @package mod_lesson
+ * @category log
* @copyright 2010 Petr Skoda (http://skodak.org)
* @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
*/
View
@@ -17,8 +17,8 @@
/**
* LTI web service endpoints
*
- * @package mod
- * @subpackage lti
+ * @package mod_lti
+ * @category log
* @copyright Copyright (c) 2011 Moodlerooms Inc. (http://www.moodlerooms.com)
* @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
* @author Chris Scribner
View
@@ -18,8 +18,8 @@
/**
* Definition of log events
*
- * @package mod
- * @subpackage page
+ * @package mod_page
+ * @category log
* @copyright 2010 Petr Skoda (http://skodak.org)
* @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
*/
View
@@ -17,8 +17,8 @@
/**
* Definition of log events for the quiz module.
*
- * @package mod
- * @subpackage quiz
+ * @package mod_quiz
+ * @category log
* @copyright 2010 Petr Skoda (http://skodak.org)
* @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
*/
View
@@ -18,8 +18,8 @@
/**
* Definition of log events
*
- * @package mod
- * @subpackage resource
+ * @package mod_resource
+ * @category log
* @copyright 2010 Petr Skoda (http://skodak.org)
* @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
*/
View
@@ -17,8 +17,8 @@
/**
* Definition of log events
*
- * @package mod
- * @subpackage scorm
+ * @package mod_scorm
+ * @category log
* @copyright 2010 Petr Skoda (http://skodak.org)
* @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
*/
View
@@ -18,8 +18,8 @@
/**
* Definition of log events
*
- * @package mod
- * @subpackage survey
+ * @package mod_survey
+ * @category log
* @copyright 2010 Petr Skoda (http://skodak.org)
* @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
*/
View
@@ -18,8 +18,8 @@
/**
* Definition of log events
*
- * @package mod
- * @subpackage url
+ * @package mod_url
+ * @category log
* @copyright 2010 Petr Skoda (http://skodak.org)
* @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
*/
View
@@ -18,8 +18,8 @@
/**
* Definition of log events
*
- * @package mod
- * @subpackage workshop
+ * @package mod_workshop
+ * @category log
* @copyright 2010 Petr Skoda (http://skodak.org)
* @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
*/
View
@@ -19,8 +19,7 @@
*
* Defines capablities related to logs
*
- * @package report
- * @subpackage log
+ * @package report_log
* @copyright 1999 onwards Martin Dougiamas (http://dougiamas.com)
* @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
*/
@@ -19,8 +19,7 @@
*
* Contains code that are run during the installation of report/logs
*
- * @package report
- * @subpackage log
+ * @package report_log
* @copyright 2011 Petr Skoda {@link http://skodak.org}
* @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
*/
@@ -30,7 +29,7 @@
/**
* Contains codes to be run during installation of report/logs
*
- * @global object $DB
+ * @global moodle_database $DB
* @return void
*/
function xmldb_report_log_install() {
View
@@ -19,8 +19,7 @@
*
* Generates an image representing the log data in a graphical manner for a user.
*
- * @package report
- * @subpackage log
+ * @package report_log
* @copyright 1999 onwards Martin Dougiamas (http://dougiamas.com)
* @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
*/
View
@@ -17,8 +17,7 @@
/**
* Displays different views of the logs.
*
- * @package report
- * @subpackage log
+ * @package report_log
* @copyright 1999 onwards Martin Dougiamas (http://dougiamas.com)
* @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
*/
@@ -19,8 +19,7 @@
*
* Language strings to be used by report/logs
*
- * @package report
- * @subpackage log
+ * @package report_log
* @copyright 1999 onwards Martin Dougiamas {@link http://moodle.com}
* @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
*/
View
@@ -19,8 +19,7 @@
*
* Defines the APIs used by log reports
*
- * @package report
- * @subpackage log
+ * @package report_log
* @copyright 1999 onwards Martin Dougiamas (http://dougiamas.com)
* @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
*/
@@ -64,8 +63,8 @@ function report_log_extend_navigation_user($navigation, $user, $course) {
/**
* Is current user allowed to access this report
*
- * @private defined in lib.php for performance reasons
- *
+ * @access private defined in lib.php for performance reasons
+ * @global stdClass $USER
* @param stdClass $user
* @param stdClass $course
* @return array with two elements $all, $today
@@ -119,6 +118,7 @@ function report_log_extend_navigation_module($navigation, $cm) {
/**
* Return a list of page types
+ *
* @param string $pagetype current page type
* @param stdClass $parentcontext Block's parent context
* @param stdClass $currentcontext Current context of block
Oops, something went wrong.

0 comments on commit 04252d3

Please sign in to comment.