MDL-30975 Docs Adding correct pacakge information
authorAnkit Kumar Agarwal <ankit@moodle.com>
Fri, 6 Jan 2012 05:00:24 +0000 (10:30 +0530)
committerAnkit Agarwal <ankit@moodle.com>
Mon, 13 Feb 2012 05:36:47 +0000 (11:06 +0530)
36 files changed:
lib/datalib.php
mod/assignment/db/log.php
mod/chat/db/log.php
mod/choice/db/log.php
mod/data/db/log.php
mod/feedback/db/log.php
mod/folder/db/log.php
mod/forum/db/log.php
mod/glossary/db/log.php
mod/imscp/db/log.php
mod/label/db/log.php
mod/lesson/db/log.php
mod/lti/db/log.php
mod/page/db/log.php
mod/quiz/db/log.php
mod/resource/db/log.php
mod/scorm/db/log.php
mod/survey/db/log.php
mod/url/db/log.php
mod/workshop/db/log.php
report/log/db/access.php
report/log/db/install.php
report/log/graph.php
report/log/index.php
report/log/lang/en/report_log.php
report/log/lib.php
report/log/locallib.php
report/log/settings.php
report/log/user.php
report/log/version.php
report/loglive/db/access.php
report/loglive/index.php
report/loglive/lang/en/report_loglive.php
report/loglive/lib.php
report/loglive/settings.php
report/loglive/version.php

index 5c3983a..412dfa3 100644 (file)
@@ -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
index 09e6c56..62ca1fa 100644 (file)
@@ -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
  */
index 4355e30..275f5f7 100644 (file)
@@ -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
  */
index e048776..3fd3ef9 100644 (file)
@@ -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
  */
index 3f32f53..37235c2 100644 (file)
@@ -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
  */
index a27ce3e..1b97e03 100644 (file)
@@ -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
  */
index 37b6017..6a22bcf 100644 (file)
@@ -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
  */
index b39f898..22ae66c 100644 (file)
@@ -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
  */
index 19d77d5..8f80259 100644 (file)
@@ -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
  */
index 599b40d..5c37279 100644 (file)
@@ -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
  */
index bc98f86..768cabc 100644 (file)
@@ -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
  */
index c77cceb..90ace43 100644 (file)
@@ -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
  */
index e043978..f00306e 100644 (file)
@@ -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
index e321dc2..915a5a1 100644 (file)
@@ -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
  */
index c5a31e7..f86c835 100644 (file)
@@ -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
  */
index 687bc0c..4fd4d22 100644 (file)
@@ -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
  */
index 2448fb0..6e8a014 100644 (file)
@@ -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
  */
index 293ffe0..c0a7917 100644 (file)
@@ -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
  */
index 9edde72..a393eb9 100644 (file)
@@ -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
  */
index 82627ed..19d04e4 100644 (file)
@@ -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
  */
index f4073e6..9ef82f2 100644 (file)
@@ -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
  */
index 04d1679..14c2386 100644 (file)
@@ -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 @@ defined('MOODLE_INTERNAL') || die;
 /**
  * Contains codes to be run during installation of report/logs
  * 
- * @global object $DB
+ * @global moodle_database $DB
  * @return void
  */
 function xmldb_report_log_install() {
index 5a5754f..44faa90 100644 (file)
@@ -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
  */
index 08434eb..c0a94fe 100644 (file)
@@ -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
  */
index f5b8ece..c2ceda0 100644 (file)
@@ -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
  */
index cf9f08d..58acedf 100644 (file)
@@ -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
index 656b38e..3102d50 100644 (file)
@@ -19,8 +19,7 @@
  *
  * This files lists the functions that are used during the log report generation.
  *
- * @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
  */
@@ -36,8 +35,8 @@ require_once(dirname(__FILE__).'/lib.php');
 /**
  * This function is used to generate and display the log activity graph
  *
- * @global object $CFG
- * @param  object $course course instance
+ * @global stdClass $CFG
+ * @param  stdClass $course course instance
  * @param  int    $userid id of the user whose logs are needed
  * @param  string $type type of logs graph needed (usercourse.png/userday.png)
  * @return void
@@ -55,27 +54,27 @@ function report_log_print_graph($course, $userid, $type, $date=0) {
 /**
  * This function is used to generate and display Mnet selector form
  *
- * @global object $USER
- * @global object $CFG
- * @global object $SITE
- * @global object $DB
- * @global object $OUTPUT
- * @global object $SESSION
+ * @global stdClass $USER
+ * @global stdClass $CFG
+ * @global stdClass $SITE
+ * @global moodle_database $DB
+ * @global core_renderer $OUTPUT
+ * @global stdClass $SESSION
  * @uses CONTEXT_SYSTEM
  * @uses COURSE_MAX_COURSES_PER_DROPDOWN
  * @uses CONTEXT_COURSE
  * @uses SEPARATEGROUPS
- * @param  int    $hostid host id
- * @param  object $course course instance
- * @param  int    $selecteduser id of the selected user
- * @param  string $selecteddate Date selected
- * @param  string $modname course_module->id
- * @param  string $modid number or 'site_errors'
- * @param  string $modaction an action as recorded in the logs
- * @param  int    $selectedgroup Group to display
- * @param  int    $showcourses whether to show courses if we're over our limit.
- * @param  int    $showusers whether to show users if we're over our limit.
- * @param  string $logformat Format of the logs (downloadascsv, showashtml, downloadasods, downloadasexcel)
+ * @param  int      $hostid host id
+ * @param  stdClass $course course instance
+ * @param  int      $selecteduser id of the selected user
+ * @param  string   $selecteddate Date selected
+ * @param  string   $modname course_module->id
+ * @param  string   $modid number or 'site_errors'
+ * @param  string   $modaction an action as recorded in the logs
+ * @param  int      $selectedgroup Group to display
+ * @param  int      $showcourses whether to show courses if we're over our limit.
+ * @param  int      $showusers whether to show users if we're over our limit.
+ * @param  string   $logformat Format of the logs (downloadascsv, showashtml, downloadasods, downloadasexcel)
  * @return void
  */
 function report_log_print_mnet_selector_form($hostid, $course, $selecteduser=0, $selecteddate='today',
@@ -365,25 +364,25 @@ function report_log_print_mnet_selector_form($hostid, $course, $selecteduser=0,
 /**
  * This function is used to generate and display selector form
  *
- * @global object $USER
- * @global object $CFG
- * @global object $DB
- * @global object $OUTPUT
- * @global object $SESSION
+ * @global stdClass $USER
+ * @global stdClass $CFG
+ * @global moodle_database $DB
+ * @global core_renderer $OUTPUT
+ * @global stdClass $SESSION
  * @uses CONTEXT_SYSTEM
  * @uses COURSE_MAX_COURSES_PER_DROPDOWN
  * @uses CONTEXT_COURSE
  * @uses SEPARATEGROUPS
- * @param  object $course course instance
- * @param  int    $selecteduser id of the selected user
- * @param  string $selecteddate Date selected
- * @param  string $modname course_module->id
- * @param  string $modid number or 'site_errors'
- * @param  string $modaction an action as recorded in the logs
- * @param  int    $selectedgroup Group to display
- * @param  int    $showcourses whether to show courses if we're over our limit.
- * @param  int    $showusers whether to show users if we're over our limit.
- * @param  string $logformat Format of the logs (downloadascsv, showashtml, downloadasods, downloadasexcel)
+ * @param  stdClass $course course instance
+ * @param  int      $selecteduser id of the selected user
+ * @param  string   $selecteddate Date selected
+ * @param  string   $modname course_module->id
+ * @param  string   $modid number or 'site_errors'
+ * @param  string   $modaction an action as recorded in the logs
+ * @param  int      $selectedgroup Group to display
+ * @param  int      $showcourses whether to show courses if we're over our limit.
+ * @param  int      $showusers whether to show users if we're over our limit.
+ * @param  string   $logformat Format of the logs (downloadascsv, showashtml, downloadasods, downloadasexcel)
  * @return void
  */
 function report_log_print_selector_form($course, $selecteduser=0, $selecteddate='today',
index 4e429e2..f202b31 100644 (file)
@@ -19,8 +19,7 @@
  *
  * Contains settings used by logs report.
  * 
- * @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
  */
index 0a51e73..32ed582 100644 (file)
@@ -17,8 +17,7 @@
 /**
  * Display user activity reports for a course (totals)
  *
- * @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
  */
index 5176abf..8ba3d8a 100644 (file)
@@ -19,8 +19,7 @@
  *
  * This File contains information about the current version of report/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
  */
index bd88770..e1b75c0 100644 (file)
@@ -19,8 +19,7 @@
  *
  * This files lists capabilites related to report_logline
  * 
- * @package    report
- * @subpackage loglive
+ * @package    report_loglive
  * @copyright  2011 Petr Skoda
  * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
  */
index 21180a4..c82f766 100644 (file)
@@ -19,8 +19,7 @@
  *
  * This file generates live view of recent logs.
  * 
- * @package    report
- * @subpackage loglive
+ * @package    report_loglive
  * @copyright  2011 Petr Skoda
  * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
  */
index 39f689f..2f90ae1 100644 (file)
@@ -19,8 +19,7 @@
  *
  * Language strings used by report_loglive
  * 
- * @package    report
- * @subpackage loglive
+ * @package    report_loglive
  * @copyright  2011 Petr Skoda
  * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
  */
index 1b3a332..b233d26 100644 (file)
@@ -19,8 +19,7 @@
  *
  * NOTE: page type not included because there can not be any blocks in popups
  *
- * @package    report
- * @subpackage loglive
+ * @package    report_loglive
  * @copyright  2011 Petr Skoda
  * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
  */
@@ -30,6 +29,8 @@ defined('MOODLE_INTERNAL') || die;
 /**
  * This function extends the navigation with the report items
  *
+ * @global stdClass $CFG
+ * @global core_renderer $OUTPUT
  * @param navigation_node $navigation The navigation node to extend
  * @param stdClass        $course     The course to object for the report
  * @param stdClass        $context    The context of the course
index a5365c4..f94510b 100644 (file)
@@ -19,8 +19,7 @@
  *
  * This file contains links and settings used by report_loglive
  * 
- * @package    report
- * @subpackage loglive
+ * @package    report_loglive
  * @copyright  2011 Petr Skoda
  * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
  */
index c60a235..a2d255c 100644 (file)
@@ -19,8 +19,7 @@
  *
  * This file contains version information about report_loglive
  *  
- * @package    report
- * @subpackage loglive
+ * @package    report_loglive
  * @copyright  2011 Petr Skoda
  * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
  */