standardized PHPDocs package info

This commit is contained in:
Petr Skoda 2010-09-06 11:29:21 +00:00
parent 5d354ded1a
commit d078f6d38e
30 changed files with 124 additions and 114 deletions

View File

@ -18,7 +18,7 @@
/** /**
* Main administration script. * Main administration script.
* *
* @package moodlecore * @package core
* @copyright 1999 onwards Martin Dougiamas (http://dougiamas.com) * @copyright 1999 onwards Martin Dougiamas (http://dougiamas.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 @@
/** /**
* Page to allow the administrator to delete networked hosts, with a confirm message * Page to allow the administrator to delete networked hosts, with a confirm message
* *
* @package moodlecore * @package core
* @subpackage mnet
* @copyright 2007 Donal McMullan * @copyright 2007 Donal McMullan
* @copyright 2007 Martin Langhoff * @copyright 2007 Martin Langhoff
* @copyright 2010 Penny Leach * @copyright 2010 Penny Leach

View File

@ -19,7 +19,8 @@
/** /**
* Page to allow the administrator to configure networked hosts, and add new ones * Page to allow the administrator to configure networked hosts, and add new ones
* *
* @package moodlecore * @package core
* @subpackage mnet
* @copyright 2007 Donal McMullan * @copyright 2007 Donal McMullan
* @copyright 2007 Martin Langhoff * @copyright 2007 Martin Langhoff
* @copyright 2010 Penny Leach * @copyright 2010 Penny Leach

View File

@ -19,7 +19,8 @@
/** /**
* This page is for configuring which services are published/subscribed on a host * This page is for configuring which services are published/subscribed on a host
* *
* @package moodlecore * @package core
* @subpackage mnet
* @copyright 2010 Penny Leach * @copyright 2010 Penny Leach
* @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 @@
/** /**
* The form for configuring which services are subscribed and published on a host * The form for configuring which services are subscribed and published on a host
* *
* @package moodlecore * @package core
* @subpackage mnet
* @copyright 2010 Penny Leach * @copyright 2010 Penny Leach
* @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 @@
* $mnet_peer object must be set and bootstrapped * $mnet_peer object must be set and bootstrapped
* $currenttab string must be set * $currenttab string must be set
* *
* @package moodlecore * @package core
* @subpackage mnet
* @copyright 2007 Donal McMullan * @copyright 2007 Donal McMullan
* @copyright 2007 Martin Langhoff * @copyright 2007 Martin Langhoff
* @copyright 2010 Penny Leach * @copyright 2010 Penny Leach

View File

@ -5,6 +5,8 @@
* This script 'remotely' executes the reflection methods on a remote Moodle, * This script 'remotely' executes the reflection methods on a remote Moodle,
* and publishes the details of the available services * and publishes the details of the available services
* *
* @package core
* @subpackage mnet
* @author Donal McMullan donal@catalyst.net.nz * @author Donal McMullan donal@catalyst.net.nz
* @version 0.0.1 * @version 0.0.1
* @license http://www.gnu.org/copyleft/gpl.html GNU Public License * @license http://www.gnu.org/copyleft/gpl.html GNU Public License

View File

@ -24,7 +24,7 @@
* file.php/courseid/dir (returns index.html from dir) * file.php/courseid/dir (returns index.html from dir)
* Workaround: file.php?file=/courseid/dir/dir/dir/filename.ext * Workaround: file.php?file=/courseid/dir/dir/dir/filename.ext
* *
* @package moodlecore * @package core
* @subpackage file * @subpackage file
* @copyright 1999 onwards Martin Dougiamas (http://dougiamas.com) * @copyright 1999 onwards Martin Dougiamas (http://dougiamas.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

@ -2235,9 +2235,10 @@ function file_modify_html_header($text) {
* $html = $c->put('http://example.com/', array('file'=>'/var/www/test.txt'); * $html = $c->put('http://example.com/', array('file'=>'/var/www/test.txt');
* </code> * </code>
* *
* @package moodlecore * @package core
* @author Dongsheng Cai <dongsheng@cvs.moodle.org> * @subpackage file
* @license http://www.gnu.org/copyleft/gpl.html GNU Public License * @author Dongsheng Cai <dongsheng@cvs.moodle.org>
* @license http://www.gnu.org/copyleft/gpl.html GNU Public License
*/ */
class curl { class curl {
@ -2743,10 +2744,10 @@ class curl {
* $ret = $c->get('http://www.google.com'); * $ret = $c->get('http://www.google.com');
* </code> * </code>
* *
* @package moodlecore * @package core
* @subpackage file * @subpackage file
* @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
*/ */
class curl_cache { class curl_cache {
/** @var string */ /** @var string */
@ -2865,10 +2866,10 @@ class curl_cache {
* extensions by file types. * extensions by file types.
* The file_types.mm file can be edited by freemind in graphic environment. * The file_types.mm file can be edited by freemind in graphic environment.
* *
* @package moodlecore * @package core
* @subpackage file * @subpackage file
* @copyright 2009 Dongsheng Cai <dongsheng@moodle.com> * @copyright 2009 Dongsheng Cai <dongsheng@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
*/ */
class filetype_parser { class filetype_parser {
/** /**

View File

@ -19,12 +19,12 @@
* repository_alfresco class * repository_alfresco class
* This is a class used to browse files from alfresco * This is a class used to browse files from alfresco
* *
* @since 2.0 * @since 2.0
* @package moodlecore * @package repository
* @subpackage repository * @subpackage alfresco
* @copyright 2009 Dongsheng Cai * @copyright 2009 Dongsheng Cai
* @author Dongsheng Cai <dongsheng@moodle.com> * @author Dongsheng Cai <dongsheng@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
*/ */
class repository_alfresco extends repository { class repository_alfresco extends repository {

View File

@ -22,11 +22,11 @@ require_once($CFG->libdir.'/boxlib.php');
* This is a subclass of repository class * This is a subclass of repository class
* *
* @since 2.0 * @since 2.0
* @package moodlecore * @package repository
* @subpackage repository * @subpackage boxnet
* @copyright 2009 Dongsheng Cai * @copyright 2009 Dongsheng Cai
* @author Dongsheng Cai <dongsheng@moodle.com> * @author Dongsheng Cai <dongsheng@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
*/ */
class repository_boxnet extends repository { class repository_boxnet extends repository {
private $box; private $box;

View File

@ -19,10 +19,10 @@
* repository_coursefiles class is used to browse course files * repository_coursefiles class is used to browse course files
* *
* @since 2.0 * @since 2.0
* @package moodlecore * @package repository
* @subpackage repository * @subpackage coursefiles
* @copyright 2010 Dongsheng Cai <dongsheng@moodle.com> * @copyright 2010 Dongsheng Cai <dongsheng@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
*/ */
class repository_coursefiles extends repository { class repository_coursefiles extends repository {

View File

@ -25,11 +25,11 @@
* http://code.google.com/p/dropbox-php/ has the same problem * http://code.google.com/p/dropbox-php/ has the same problem
* *
* @since 2.0 * @since 2.0
* @package moodlecore * @package repository
* @subpackage repository * @subpackage dropbox
* @copyright 2010 Dongsheng Cai * @copyright 2010 Dongsheng Cai
* @author Dongsheng Cai <dongsheng@moodle.com> * @author Dongsheng Cai <dongsheng@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
*/ */
require_once(dirname(__FILE__).'/locallib.php'); require_once(dirname(__FILE__).'/locallib.php');

View File

@ -20,11 +20,11 @@
* A helper class to access dropbox resources * A helper class to access dropbox resources
* *
* @since 2.0 * @since 2.0
* @package moodlecore * @package repository
* @subpackage repository * @subpackage dropbox
* @copyright 2010 Dongsheng Cai * @copyright 2010 Dongsheng Cai
* @author Dongsheng Cai <dongsheng@moodle.com> * @author Dongsheng Cai <dongsheng@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

@ -22,11 +22,11 @@
* which is %moodledata%/repository * which is %moodledata%/repository
* *
* @since 2.0 * @since 2.0
* @package moodlecore * @package repository
* @subpackage repository * @subpackage filesystem
* @copyright 2009 Dongsheng Cai * @copyright 2009 Dongsheng Cai
* @author Dongsheng Cai <dongsheng@moodle.com> * @author Dongsheng Cai <dongsheng@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
*/ */
class repository_filesystem extends repository { class repository_filesystem extends repository {
public function __construct($repositoryid, $context = SYSCONTEXTID, $options = array()) { public function __construct($repositoryid, $context = SYSCONTEXTID, $options = array()) {

View File

@ -20,11 +20,11 @@
* This plugin is used to access user's private flickr repository * This plugin is used to access user's private flickr repository
* *
* @since 2.0 * @since 2.0
* @package moodlecore * @package repository
* @subpackage repository * @subpackage flickr
* @copyright 2009 Dongsheng Cai * @copyright 2009 Dongsheng Cai
* @author Dongsheng Cai <dongsheng@moodle.com> * @author Dongsheng Cai <dongsheng@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
*/ */
require_once($CFG->libdir.'/flickrlib.php'); require_once($CFG->libdir.'/flickrlib.php');

View File

@ -18,8 +18,10 @@
/** /**
* moodle_image class * moodle_image class
* *
* @author Dongsheng Cai <dongsheng@moodle.com> * @package repository
* @license http://www.gnu.org/copyleft/gpl.html GNU Public License * @subpackage flickr_public
* @author Dongsheng Cai <dongsheng@moodle.com>
* @license http://www.gnu.org/copyleft/gpl.html GNU Public License
*/ */
class moodle_image { class moodle_image {
private $imagepath; private $imagepath;

View File

@ -22,11 +22,11 @@
* flickr photos from this plugin * flickr photos from this plugin
* *
* @since 2.0 * @since 2.0
* @package moodlecore * @package repository
* @subpackage repository * @subpackage flickr_public
* @copyright 2009 Dongsheng Cai * @copyright 2009 Dongsheng Cai
* @author Dongsheng Cai <dongsheng@moodle.com> * @author Dongsheng Cai <dongsheng@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
*/ */
require_once($CFG->libdir.'/flickrlib.php'); require_once($CFG->libdir.'/flickrlib.php');

View File

@ -19,10 +19,10 @@
* Google Docs Plugin * Google Docs Plugin
* *
* @since 2.0 * @since 2.0
* @package moodlecore * @package repository
* @subpackage repository * @subpackage googledocs
* @copyright 2009 Dan Poltawski <talktodan@gmail.com> * @copyright 2009 Dan Poltawski <talktodan@gmail.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
*/ */
require_once($CFG->libdir.'/googleapi.php'); require_once($CFG->libdir.'/googleapi.php');

View File

@ -19,10 +19,10 @@
* repository_local class is used to browse moodle files * repository_local class is used to browse moodle files
* *
* @since 2.0 * @since 2.0
* @package moodlecore * @package repository
* @subpackage repository * @subpackage local
* @copyright 2009 Dongsheng Cai <dongsheng@moodle.com> * @copyright 2009 Dongsheng Cai <dongsheng@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
*/ */
class repository_local extends repository { class repository_local extends repository {

View File

@ -19,11 +19,11 @@
* repository_merlot is used to search merlot.org in moodle * repository_merlot is used to search merlot.org in moodle
* *
* @since 2.0 * @since 2.0
* @package moodlecore * @package repository
* @subpackage repository * @subpackage merlot
* @copyright 2009 Dongsheng Cai * @copyright 2009 Dongsheng Cai
* @author Dongsheng Cai <dongsheng@moodle.com> * @author Dongsheng Cai <dongsheng@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
*/ */
class repository_merlot extends repository { class repository_merlot extends repository {

View File

@ -19,11 +19,11 @@
* Picasa Repository Plugin * Picasa Repository Plugin
* *
* @since 2.0 * @since 2.0
* @package moodlecore * @package repository
* @subpackage repository * @subpackage picasa
* @copyright 2009 Dan Poltawski * @copyright 2009 Dan Poltawski
* @author Dan Poltawski <talktodan@gmail.com> * @author Dan Poltawski <talktodan@gmail.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
*/ */
require_once($CFG->libdir.'/googleapi.php'); require_once($CFG->libdir.'/googleapi.php');

View File

@ -19,10 +19,10 @@
* repository_recent class is used to browse recent used files * repository_recent class is used to browse recent used files
* *
* @since 2.0 * @since 2.0
* @package moodlecore * @package repository
* @subpackage repository * @subpackage recent
* @copyright 2010 Dongsheng Cai <dongsheng@moodle.com> * @copyright 2010 Dongsheng Cai <dongsheng@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
*/ */
define('DEFAULT_RECENT_FILES_NUM', 50); define('DEFAULT_RECENT_FILES_NUM', 50);

View File

@ -20,11 +20,11 @@
* This is a repository class used to browse Amazon S3 content. * This is a repository class used to browse Amazon S3 content.
* *
* @since 2.0 * @since 2.0
* @package moodlecore * @package repository
* @subpackage repository * @subpackage s3
* @copyright 2009 Dongsheng Cai * @copyright 2009 Dongsheng Cai
* @author Dongsheng Cai <dongsheng@moodle.com> * @author Dongsheng Cai <dongsheng@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
*/ */
require_once('S3.php'); require_once('S3.php');

View File

@ -19,11 +19,11 @@
* A repository plugin to allow user uploading files * A repository plugin to allow user uploading files
* *
* @since 2.0 * @since 2.0
* @package moodlecore * @package repository
* @subpackage repository * @subpackage upload
* @copyright 2009 Dongsheng Cai * @copyright 2009 Dongsheng Cai
* @author Dongsheng Cai <dongsheng@moodle.com> * @author Dongsheng Cai <dongsheng@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
*/ */
class repository_upload extends repository { class repository_upload extends repository {

View File

@ -20,11 +20,11 @@
* A subclass of repository, which is used to download a file from a specific url * A subclass of repository, which is used to download a file from a specific url
* *
* @since 2.0 * @since 2.0
* @package moodlecore * @package repository
* @subpackage repository * @subpackage url
* @copyright 2009 Dongsheng Cai * @copyright 2009 Dongsheng Cai
* @author Dongsheng Cai <dongsheng@moodle.com> * @author Dongsheng Cai <dongsheng@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
*/ */
require_once(dirname(__FILE__).'/locallib.php'); require_once(dirname(__FILE__).'/locallib.php');

View File

@ -19,10 +19,10 @@
* repository_user class is used to browse user private files * repository_user class is used to browse user private files
* *
* @since 2.0 * @since 2.0
* @package moodlecore * @package repository
* @subpackage repository * @subpackage user
* @copyright 2010 Dongsheng Cai <dongsheng@moodle.com> * @copyright 2010 Dongsheng Cai <dongsheng@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
*/ */
class repository_user extends repository { class repository_user extends repository {

View File

@ -19,11 +19,11 @@
* repository_webdav class * repository_webdav class
* *
* @since 2.0 * @since 2.0
* @package moodlecore * @package repository
* @subpackage repository * @subpackage webdav
* @copyright 2009 Dongsheng Cai * @copyright 2009 Dongsheng Cai
* @author Dongsheng Cai <dongsheng@moodle.com> * @author Dongsheng Cai <dongsheng@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
*/ */
require_once($CFG->libdir.'/webdavlib.php'); require_once($CFG->libdir.'/webdavlib.php');

View File

@ -22,11 +22,11 @@ require_once('wikimedia.php');
* This is a class used to browse images from wikimedia * This is a class used to browse images from wikimedia
* *
* @since 2.0 * @since 2.0
* @package moodlecore * @package repository
* @subpackage repository * @subpackage wikimedia
* @copyright 2009 Dongsheng Cai * @copyright 2009 Dongsheng Cai
* @author Dongsheng Cai <dongsheng@moodle.com> * @author Dongsheng Cai <dongsheng@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
*/ */
class repository_wikimedia extends repository { class repository_wikimedia extends repository {

View File

@ -19,11 +19,11 @@
* repository_youtube class * repository_youtube class
* *
* @since 2.0 * @since 2.0
* @package moodlecore * @package repository
* @subpackage repository * @subpackage youtube
* @copyright 2009 Dongsheng Cai * @copyright 2009 Dongsheng Cai
* @author Dongsheng Cai <dongsheng@moodle.com> * @author Dongsheng Cai <dongsheng@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
*/ */
class repository_youtube extends repository { class repository_youtube extends repository {