From d078f6d38e1a99eca9473624018c39b772be8407 Mon Sep 17 00:00:00 2001 From: Petr Skoda Date: Mon, 6 Sep 2010 11:29:21 +0000 Subject: [PATCH] standardized PHPDocs package info --- admin/index.php | 2 +- admin/mnet/delete.php | 3 ++- admin/mnet/peers.php | 3 ++- admin/mnet/services.php | 3 ++- admin/mnet/services_form.php | 3 ++- admin/mnet/tabs.php | 3 ++- admin/mnet/testclient.php | 2 ++ file.php | 2 +- lib/filelib.php | 19 ++++++++++--------- repository/alfresco/lib.php | 12 ++++++------ repository/boxnet/lib.php | 10 +++++----- repository/coursefiles/lib.php | 8 ++++---- repository/dropbox/lib.php | 10 +++++----- repository/dropbox/locallib.php | 10 +++++----- repository/filesystem/lib.php | 10 +++++----- repository/flickr/lib.php | 10 +++++----- repository/flickr_public/image.php | 6 ++++-- repository/flickr_public/lib.php | 10 +++++----- repository/googledocs/lib.php | 8 ++++---- repository/local/lib.php | 8 ++++---- repository/merlot/lib.php | 10 +++++----- repository/picasa/lib.php | 10 +++++----- repository/recent/lib.php | 8 ++++---- repository/s3/lib.php | 10 +++++----- repository/upload/lib.php | 10 +++++----- repository/url/lib.php | 10 +++++----- repository/user/lib.php | 8 ++++---- repository/webdav/lib.php | 10 +++++----- repository/wikimedia/lib.php | 10 +++++----- repository/youtube/lib.php | 10 +++++----- 30 files changed, 124 insertions(+), 114 deletions(-) diff --git a/admin/index.php b/admin/index.php index 4704db9fe10..37985c77c4e 100644 --- a/admin/index.php +++ b/admin/index.php @@ -18,7 +18,7 @@ /** * Main administration script. * - * @package moodlecore + * @package core * @copyright 1999 onwards Martin Dougiamas (http://dougiamas.com) * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later */ diff --git a/admin/mnet/delete.php b/admin/mnet/delete.php index e48b055efb4..e3a7e3f07fb 100644 --- a/admin/mnet/delete.php +++ b/admin/mnet/delete.php @@ -19,7 +19,8 @@ /** * 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 Martin Langhoff * @copyright 2010 Penny Leach diff --git a/admin/mnet/peers.php b/admin/mnet/peers.php index 6ff471c9268..0c334d09ba0 100644 --- a/admin/mnet/peers.php +++ b/admin/mnet/peers.php @@ -19,7 +19,8 @@ /** * 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 Martin Langhoff * @copyright 2010 Penny Leach diff --git a/admin/mnet/services.php b/admin/mnet/services.php index 0e6dcb57e5e..d496f47a6e6 100644 --- a/admin/mnet/services.php +++ b/admin/mnet/services.php @@ -19,7 +19,8 @@ /** * This page is for configuring which services are published/subscribed on a host * - * @package moodlecore + * @package core + * @subpackage mnet * @copyright 2010 Penny Leach * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later */ diff --git a/admin/mnet/services_form.php b/admin/mnet/services_form.php index 26256403fe1..3bda9612d2b 100644 --- a/admin/mnet/services_form.php +++ b/admin/mnet/services_form.php @@ -19,7 +19,8 @@ /** * The form for configuring which services are subscribed and published on a host * - * @package moodlecore + * @package core + * @subpackage mnet * @copyright 2010 Penny Leach * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later */ diff --git a/admin/mnet/tabs.php b/admin/mnet/tabs.php index 8648895352e..c7c50a9d89e 100644 --- a/admin/mnet/tabs.php +++ b/admin/mnet/tabs.php @@ -21,7 +21,8 @@ * $mnet_peer object must be set and bootstrapped * $currenttab string must be set * - * @package moodlecore + * @package core + * @subpackage mnet * @copyright 2007 Donal McMullan * @copyright 2007 Martin Langhoff * @copyright 2010 Penny Leach diff --git a/admin/mnet/testclient.php b/admin/mnet/testclient.php index 054e5934f4e..f4d2c96053a 100644 --- a/admin/mnet/testclient.php +++ b/admin/mnet/testclient.php @@ -5,6 +5,8 @@ * This script 'remotely' executes the reflection methods on a remote Moodle, * and publishes the details of the available services * + * @package core + * @subpackage mnet * @author Donal McMullan donal@catalyst.net.nz * @version 0.0.1 * @license http://www.gnu.org/copyleft/gpl.html GNU Public License diff --git a/file.php b/file.php index 5f9a61c89e5..55854897c5f 100644 --- a/file.php +++ b/file.php @@ -24,7 +24,7 @@ * file.php/courseid/dir (returns index.html from dir) * Workaround: file.php?file=/courseid/dir/dir/dir/filename.ext * - * @package moodlecore + * @package core * @subpackage file * @copyright 1999 onwards Martin Dougiamas (http://dougiamas.com) * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later diff --git a/lib/filelib.php b/lib/filelib.php index d030df0424b..607fdbce2f5 100644 --- a/lib/filelib.php +++ b/lib/filelib.php @@ -2235,9 +2235,10 @@ function file_modify_html_header($text) { * $html = $c->put('http://example.com/', array('file'=>'/var/www/test.txt'); * * - * @package moodlecore - * @author Dongsheng Cai - * @license http://www.gnu.org/copyleft/gpl.html GNU Public License + * @package core + * @subpackage file + * @author Dongsheng Cai + * @license http://www.gnu.org/copyleft/gpl.html GNU Public License */ class curl { @@ -2743,10 +2744,10 @@ class curl { * $ret = $c->get('http://www.google.com'); * * - * @package moodlecore + * @package core * @subpackage file - * @copyright 1999 onwards Martin Dougiamas {@link http://moodle.com} - * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later + * @copyright 1999 onwards Martin Dougiamas {@link http://moodle.com} + * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later */ class curl_cache { /** @var string */ @@ -2865,10 +2866,10 @@ class curl_cache { * extensions by file types. * The file_types.mm file can be edited by freemind in graphic environment. * - * @package moodlecore + * @package core * @subpackage file - * @copyright 2009 Dongsheng Cai - * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later + * @copyright 2009 Dongsheng Cai + * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later */ class filetype_parser { /** diff --git a/repository/alfresco/lib.php b/repository/alfresco/lib.php index 108898817a1..9b0f6de4621 100755 --- a/repository/alfresco/lib.php +++ b/repository/alfresco/lib.php @@ -19,12 +19,12 @@ * repository_alfresco class * This is a class used to browse files from alfresco * - * @since 2.0 - * @package moodlecore - * @subpackage repository - * @copyright 2009 Dongsheng Cai - * @author Dongsheng Cai - * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later + * @since 2.0 + * @package repository + * @subpackage alfresco + * @copyright 2009 Dongsheng Cai + * @author Dongsheng Cai + * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later */ class repository_alfresco extends repository { diff --git a/repository/boxnet/lib.php b/repository/boxnet/lib.php index 002dea9f372..b1fdda3f7f5 100755 --- a/repository/boxnet/lib.php +++ b/repository/boxnet/lib.php @@ -22,11 +22,11 @@ require_once($CFG->libdir.'/boxlib.php'); * This is a subclass of repository class * * @since 2.0 - * @package moodlecore - * @subpackage repository - * @copyright 2009 Dongsheng Cai - * @author Dongsheng Cai - * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later + * @package repository + * @subpackage boxnet + * @copyright 2009 Dongsheng Cai + * @author Dongsheng Cai + * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later */ class repository_boxnet extends repository { private $box; diff --git a/repository/coursefiles/lib.php b/repository/coursefiles/lib.php index 478491f752d..858f7ea0c1f 100755 --- a/repository/coursefiles/lib.php +++ b/repository/coursefiles/lib.php @@ -19,10 +19,10 @@ * repository_coursefiles class is used to browse course files * * @since 2.0 - * @package moodlecore - * @subpackage repository - * @copyright 2010 Dongsheng Cai - * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later + * @package repository + * @subpackage coursefiles + * @copyright 2010 Dongsheng Cai + * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later */ class repository_coursefiles extends repository { diff --git a/repository/dropbox/lib.php b/repository/dropbox/lib.php index 5fab04a0ab3..69fdc5c3781 100644 --- a/repository/dropbox/lib.php +++ b/repository/dropbox/lib.php @@ -25,11 +25,11 @@ * http://code.google.com/p/dropbox-php/ has the same problem * * @since 2.0 - * @package moodlecore - * @subpackage repository - * @copyright 2010 Dongsheng Cai - * @author Dongsheng Cai - * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later + * @package repository + * @subpackage dropbox + * @copyright 2010 Dongsheng Cai + * @author Dongsheng Cai + * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later */ require_once(dirname(__FILE__).'/locallib.php'); diff --git a/repository/dropbox/locallib.php b/repository/dropbox/locallib.php index 963124c6471..b0c55d6ef11 100644 --- a/repository/dropbox/locallib.php +++ b/repository/dropbox/locallib.php @@ -20,11 +20,11 @@ * A helper class to access dropbox resources * * @since 2.0 - * @package moodlecore - * @subpackage repository - * @copyright 2010 Dongsheng Cai - * @author Dongsheng Cai - * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later + * @package repository + * @subpackage dropbox + * @copyright 2010 Dongsheng Cai + * @author Dongsheng Cai + * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later */ diff --git a/repository/filesystem/lib.php b/repository/filesystem/lib.php index d553a9e1246..6133434411b 100644 --- a/repository/filesystem/lib.php +++ b/repository/filesystem/lib.php @@ -22,11 +22,11 @@ * which is %moodledata%/repository * * @since 2.0 - * @package moodlecore - * @subpackage repository - * @copyright 2009 Dongsheng Cai - * @author Dongsheng Cai - * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later + * @package repository + * @subpackage filesystem + * @copyright 2009 Dongsheng Cai + * @author Dongsheng Cai + * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later */ class repository_filesystem extends repository { public function __construct($repositoryid, $context = SYSCONTEXTID, $options = array()) { diff --git a/repository/flickr/lib.php b/repository/flickr/lib.php index 13ffaa82a3e..fef2ded8cc0 100755 --- a/repository/flickr/lib.php +++ b/repository/flickr/lib.php @@ -20,11 +20,11 @@ * This plugin is used to access user's private flickr repository * * @since 2.0 - * @package moodlecore - * @subpackage repository - * @copyright 2009 Dongsheng Cai - * @author Dongsheng Cai - * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later + * @package repository + * @subpackage flickr + * @copyright 2009 Dongsheng Cai + * @author Dongsheng Cai + * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later */ require_once($CFG->libdir.'/flickrlib.php'); diff --git a/repository/flickr_public/image.php b/repository/flickr_public/image.php index feb6b48a0fe..254c6de50df 100755 --- a/repository/flickr_public/image.php +++ b/repository/flickr_public/image.php @@ -18,8 +18,10 @@ /** * moodle_image class * - * @author Dongsheng Cai - * @license http://www.gnu.org/copyleft/gpl.html GNU Public License + * @package repository + * @subpackage flickr_public + * @author Dongsheng Cai + * @license http://www.gnu.org/copyleft/gpl.html GNU Public License */ class moodle_image { private $imagepath; diff --git a/repository/flickr_public/lib.php b/repository/flickr_public/lib.php index 465a8cef948..bd2699615b3 100644 --- a/repository/flickr_public/lib.php +++ b/repository/flickr_public/lib.php @@ -22,11 +22,11 @@ * flickr photos from this plugin * * @since 2.0 - * @package moodlecore - * @subpackage repository - * @copyright 2009 Dongsheng Cai - * @author Dongsheng Cai - * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later + * @package repository + * @subpackage flickr_public + * @copyright 2009 Dongsheng Cai + * @author Dongsheng Cai + * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later */ require_once($CFG->libdir.'/flickrlib.php'); diff --git a/repository/googledocs/lib.php b/repository/googledocs/lib.php index af5da7e8cb1..e8718ed3c42 100644 --- a/repository/googledocs/lib.php +++ b/repository/googledocs/lib.php @@ -19,10 +19,10 @@ * Google Docs Plugin * * @since 2.0 - * @package moodlecore - * @subpackage repository - * @copyright 2009 Dan Poltawski - * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later + * @package repository + * @subpackage googledocs + * @copyright 2009 Dan Poltawski + * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later */ require_once($CFG->libdir.'/googleapi.php'); diff --git a/repository/local/lib.php b/repository/local/lib.php index 0c86a16f033..04488235403 100755 --- a/repository/local/lib.php +++ b/repository/local/lib.php @@ -19,10 +19,10 @@ * repository_local class is used to browse moodle files * * @since 2.0 - * @package moodlecore - * @subpackage repository - * @copyright 2009 Dongsheng Cai - * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later + * @package repository + * @subpackage local + * @copyright 2009 Dongsheng Cai + * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later */ class repository_local extends repository { diff --git a/repository/merlot/lib.php b/repository/merlot/lib.php index 0e0f16feb14..e4974b818ac 100755 --- a/repository/merlot/lib.php +++ b/repository/merlot/lib.php @@ -19,11 +19,11 @@ * repository_merlot is used to search merlot.org in moodle * * @since 2.0 - * @package moodlecore - * @subpackage repository - * @copyright 2009 Dongsheng Cai - * @author Dongsheng Cai - * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later + * @package repository + * @subpackage merlot + * @copyright 2009 Dongsheng Cai + * @author Dongsheng Cai + * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later */ class repository_merlot extends repository { diff --git a/repository/picasa/lib.php b/repository/picasa/lib.php index 4cdf4684250..55b5b5e3545 100644 --- a/repository/picasa/lib.php +++ b/repository/picasa/lib.php @@ -19,11 +19,11 @@ * Picasa Repository Plugin * * @since 2.0 - * @package moodlecore - * @subpackage repository - * @copyright 2009 Dan Poltawski - * @author Dan Poltawski - * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later + * @package repository + * @subpackage picasa + * @copyright 2009 Dan Poltawski + * @author Dan Poltawski + * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later */ require_once($CFG->libdir.'/googleapi.php'); diff --git a/repository/recent/lib.php b/repository/recent/lib.php index 6b43d819ca6..41eb4455a69 100755 --- a/repository/recent/lib.php +++ b/repository/recent/lib.php @@ -19,10 +19,10 @@ * repository_recent class is used to browse recent used files * * @since 2.0 - * @package moodlecore - * @subpackage repository - * @copyright 2010 Dongsheng Cai - * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later + * @package repository + * @subpackage recent + * @copyright 2010 Dongsheng Cai + * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later */ define('DEFAULT_RECENT_FILES_NUM', 50); diff --git a/repository/s3/lib.php b/repository/s3/lib.php index d93d9019b17..0aa03fea8ad 100644 --- a/repository/s3/lib.php +++ b/repository/s3/lib.php @@ -20,11 +20,11 @@ * This is a repository class used to browse Amazon S3 content. * * @since 2.0 - * @package moodlecore - * @subpackage repository - * @copyright 2009 Dongsheng Cai - * @author Dongsheng Cai - * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later + * @package repository + * @subpackage s3 + * @copyright 2009 Dongsheng Cai + * @author Dongsheng Cai + * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later */ require_once('S3.php'); diff --git a/repository/upload/lib.php b/repository/upload/lib.php index acef5d34a5c..411a515f6ee 100755 --- a/repository/upload/lib.php +++ b/repository/upload/lib.php @@ -19,11 +19,11 @@ * A repository plugin to allow user uploading files * * @since 2.0 - * @package moodlecore - * @subpackage repository - * @copyright 2009 Dongsheng Cai - * @author Dongsheng Cai - * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later + * @package repository + * @subpackage upload + * @copyright 2009 Dongsheng Cai + * @author Dongsheng Cai + * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later */ class repository_upload extends repository { diff --git a/repository/url/lib.php b/repository/url/lib.php index 32da2fd5513..efcf1fb70b6 100644 --- a/repository/url/lib.php +++ b/repository/url/lib.php @@ -20,11 +20,11 @@ * A subclass of repository, which is used to download a file from a specific url * * @since 2.0 - * @package moodlecore - * @subpackage repository - * @copyright 2009 Dongsheng Cai - * @author Dongsheng Cai - * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later + * @package repository + * @subpackage url + * @copyright 2009 Dongsheng Cai + * @author Dongsheng Cai + * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later */ require_once(dirname(__FILE__).'/locallib.php'); diff --git a/repository/user/lib.php b/repository/user/lib.php index cbb08996fbe..153812fdf97 100755 --- a/repository/user/lib.php +++ b/repository/user/lib.php @@ -19,10 +19,10 @@ * repository_user class is used to browse user private files * * @since 2.0 - * @package moodlecore - * @subpackage repository - * @copyright 2010 Dongsheng Cai - * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later + * @package repository + * @subpackage user + * @copyright 2010 Dongsheng Cai + * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later */ class repository_user extends repository { diff --git a/repository/webdav/lib.php b/repository/webdav/lib.php index fd7b8a07c55..0cc85c6066c 100644 --- a/repository/webdav/lib.php +++ b/repository/webdav/lib.php @@ -19,11 +19,11 @@ * repository_webdav class * * @since 2.0 - * @package moodlecore - * @subpackage repository - * @copyright 2009 Dongsheng Cai - * @author Dongsheng Cai - * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later + * @package repository + * @subpackage webdav + * @copyright 2009 Dongsheng Cai + * @author Dongsheng Cai + * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later */ require_once($CFG->libdir.'/webdavlib.php'); diff --git a/repository/wikimedia/lib.php b/repository/wikimedia/lib.php index 6130643fc3e..0bbf874540a 100644 --- a/repository/wikimedia/lib.php +++ b/repository/wikimedia/lib.php @@ -22,11 +22,11 @@ require_once('wikimedia.php'); * This is a class used to browse images from wikimedia * * @since 2.0 - * @package moodlecore - * @subpackage repository - * @copyright 2009 Dongsheng Cai - * @author Dongsheng Cai - * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later + * @package repository + * @subpackage wikimedia + * @copyright 2009 Dongsheng Cai + * @author Dongsheng Cai + * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later */ class repository_wikimedia extends repository { diff --git a/repository/youtube/lib.php b/repository/youtube/lib.php index 55532a3b479..15f3ce10083 100644 --- a/repository/youtube/lib.php +++ b/repository/youtube/lib.php @@ -19,11 +19,11 @@ * repository_youtube class * * @since 2.0 - * @package moodlecore - * @subpackage repository - * @copyright 2009 Dongsheng Cai - * @author Dongsheng Cai - * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later + * @package repository + * @subpackage youtube + * @copyright 2009 Dongsheng Cai + * @author Dongsheng Cai + * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later */ class repository_youtube extends repository {