Skip to content

Commit

Permalink
standardized PHPDocs package info
Browse files Browse the repository at this point in the history
  • Loading branch information
skodak committed Sep 6, 2010
1 parent 5d354de commit d078f6d
Show file tree
Hide file tree
Showing 30 changed files with 124 additions and 114 deletions.
2 changes: 1 addition & 1 deletion admin/index.php
Original file line number Diff line number Diff line change
Expand Up @@ -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
*/
Expand Down
3 changes: 2 additions & 1 deletion admin/mnet/delete.php
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
3 changes: 2 additions & 1 deletion admin/mnet/peers.php
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
3 changes: 2 additions & 1 deletion admin/mnet/services.php
Original file line number Diff line number Diff line change
Expand Up @@ -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
*/
Expand Down
3 changes: 2 additions & 1 deletion admin/mnet/services_form.php
Original file line number Diff line number Diff line change
Expand Up @@ -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
*/
Expand Down
3 changes: 2 additions & 1 deletion admin/mnet/tabs.php
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
2 changes: 2 additions & 0 deletions admin/mnet/testclient.php
Original file line number Diff line number Diff line change
Expand Up @@ -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 [email protected]
* @version 0.0.1
* @license http://www.gnu.org/copyleft/gpl.html GNU Public License
Expand Down
2 changes: 1 addition & 1 deletion file.php
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
19 changes: 10 additions & 9 deletions lib/filelib.php
Original file line number Diff line number Diff line change
Expand Up @@ -2235,9 +2235,10 @@ function file_modify_html_header($text) {
* $html = $c->put('http://example.com/', array('file'=>'/var/www/test.txt');
* </code>
*
* @package moodlecore
* @author Dongsheng Cai <[email protected]>
* @license http://www.gnu.org/copyleft/gpl.html GNU Public License
* @package core
* @subpackage file
* @author Dongsheng Cai <[email protected]>
* @license http://www.gnu.org/copyleft/gpl.html GNU Public License
*/

class curl {
Expand Down Expand Up @@ -2743,10 +2744,10 @@ public function get_info() {
* $ret = $c->get('http://www.google.com');
* </code>
*
* @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 */
Expand Down Expand Up @@ -2865,10 +2866,10 @@ public function refresh(){
* 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 <[email protected]>
* @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
* @copyright 2009 Dongsheng Cai <[email protected]>
* @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
*/
class filetype_parser {
/**
Expand Down
12 changes: 6 additions & 6 deletions repository/alfresco/lib.php
Original file line number Diff line number Diff line change
Expand Up @@ -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 <[email protected]>
* @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 <[email protected]>
* @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
*/

class repository_alfresco extends repository {
Expand Down
10 changes: 5 additions & 5 deletions repository/boxnet/lib.php
Original file line number Diff line number Diff line change
Expand Up @@ -22,11 +22,11 @@
* This is a subclass of repository class
*
* @since 2.0
* @package moodlecore
* @subpackage repository
* @copyright 2009 Dongsheng Cai
* @author Dongsheng Cai <[email protected]>
* @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
* @package repository
* @subpackage boxnet
* @copyright 2009 Dongsheng Cai
* @author Dongsheng Cai <[email protected]>
* @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
*/
class repository_boxnet extends repository {
private $box;
Expand Down
8 changes: 4 additions & 4 deletions repository/coursefiles/lib.php
Original file line number Diff line number Diff line change
Expand Up @@ -19,10 +19,10 @@
* repository_coursefiles class is used to browse course files
*
* @since 2.0
* @package moodlecore
* @subpackage repository
* @copyright 2010 Dongsheng Cai <[email protected]>
* @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
* @package repository
* @subpackage coursefiles
* @copyright 2010 Dongsheng Cai <[email protected]>
* @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
*/

class repository_coursefiles extends repository {
Expand Down
10 changes: 5 additions & 5 deletions repository/dropbox/lib.php
Original file line number Diff line number Diff line change
Expand Up @@ -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 <[email protected]>
* @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
* @package repository
* @subpackage dropbox
* @copyright 2010 Dongsheng Cai
* @author Dongsheng Cai <[email protected]>
* @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
*/

require_once(dirname(__FILE__).'/locallib.php');
Expand Down
10 changes: 5 additions & 5 deletions repository/dropbox/locallib.php
Original file line number Diff line number Diff line change
Expand Up @@ -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 <[email protected]>
* @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
* @package repository
* @subpackage dropbox
* @copyright 2010 Dongsheng Cai
* @author Dongsheng Cai <[email protected]>
* @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
*/


Expand Down
10 changes: 5 additions & 5 deletions repository/filesystem/lib.php
Original file line number Diff line number Diff line change
Expand Up @@ -22,11 +22,11 @@
* which is %moodledata%/repository
*
* @since 2.0
* @package moodlecore
* @subpackage repository
* @copyright 2009 Dongsheng Cai
* @author Dongsheng Cai <[email protected]>
* @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
* @package repository
* @subpackage filesystem
* @copyright 2009 Dongsheng Cai
* @author Dongsheng Cai <[email protected]>
* @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()) {
Expand Down
10 changes: 5 additions & 5 deletions repository/flickr/lib.php
Original file line number Diff line number Diff line change
Expand Up @@ -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 <[email protected]>
* @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
* @package repository
* @subpackage flickr
* @copyright 2009 Dongsheng Cai
* @author Dongsheng Cai <[email protected]>
* @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
*/

require_once($CFG->libdir.'/flickrlib.php');
Expand Down
6 changes: 4 additions & 2 deletions repository/flickr_public/image.php
Original file line number Diff line number Diff line change
Expand Up @@ -18,8 +18,10 @@
/**
* moodle_image class
*
* @author Dongsheng Cai <[email protected]>
* @license http://www.gnu.org/copyleft/gpl.html GNU Public License
* @package repository
* @subpackage flickr_public
* @author Dongsheng Cai <[email protected]>
* @license http://www.gnu.org/copyleft/gpl.html GNU Public License
*/
class moodle_image {
private $imagepath;
Expand Down
10 changes: 5 additions & 5 deletions repository/flickr_public/lib.php
Original file line number Diff line number Diff line change
Expand Up @@ -22,11 +22,11 @@
* flickr photos from this plugin
*
* @since 2.0
* @package moodlecore
* @subpackage repository
* @copyright 2009 Dongsheng Cai
* @author Dongsheng Cai <[email protected]>
* @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 <[email protected]>
* @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
*/

require_once($CFG->libdir.'/flickrlib.php');
Expand Down
8 changes: 4 additions & 4 deletions repository/googledocs/lib.php
Original file line number Diff line number Diff line change
Expand Up @@ -19,10 +19,10 @@
* Google Docs Plugin
*
* @since 2.0
* @package moodlecore
* @subpackage repository
* @copyright 2009 Dan Poltawski <[email protected]>
* @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
* @package repository
* @subpackage googledocs
* @copyright 2009 Dan Poltawski <[email protected]>
* @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
*/

require_once($CFG->libdir.'/googleapi.php');
Expand Down
8 changes: 4 additions & 4 deletions repository/local/lib.php
Original file line number Diff line number Diff line change
Expand Up @@ -19,10 +19,10 @@
* repository_local class is used to browse moodle files
*
* @since 2.0
* @package moodlecore
* @subpackage repository
* @copyright 2009 Dongsheng Cai <[email protected]>
* @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
* @package repository
* @subpackage local
* @copyright 2009 Dongsheng Cai <[email protected]>
* @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
*/

class repository_local extends repository {
Expand Down
10 changes: 5 additions & 5 deletions repository/merlot/lib.php
Original file line number Diff line number Diff line change
Expand Up @@ -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 <[email protected]>
* @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
* @package repository
* @subpackage merlot
* @copyright 2009 Dongsheng Cai
* @author Dongsheng Cai <[email protected]>
* @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
*/
class repository_merlot extends repository {

Expand Down
10 changes: 5 additions & 5 deletions repository/picasa/lib.php
Original file line number Diff line number Diff line change
Expand Up @@ -19,11 +19,11 @@
* Picasa Repository Plugin
*
* @since 2.0
* @package moodlecore
* @subpackage repository
* @copyright 2009 Dan Poltawski
* @author Dan Poltawski <[email protected]>
* @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
* @package repository
* @subpackage picasa
* @copyright 2009 Dan Poltawski
* @author Dan Poltawski <[email protected]>
* @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
*/

require_once($CFG->libdir.'/googleapi.php');
Expand Down
8 changes: 4 additions & 4 deletions repository/recent/lib.php
Original file line number Diff line number Diff line change
Expand Up @@ -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 <[email protected]>
* @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
* @package repository
* @subpackage recent
* @copyright 2010 Dongsheng Cai <[email protected]>
* @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
*/

define('DEFAULT_RECENT_FILES_NUM', 50);
Expand Down
10 changes: 5 additions & 5 deletions repository/s3/lib.php
Original file line number Diff line number Diff line change
Expand Up @@ -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 <[email protected]>
* @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
* @package repository
* @subpackage s3
* @copyright 2009 Dongsheng Cai
* @author Dongsheng Cai <[email protected]>
* @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
*/

require_once('S3.php');
Expand Down
10 changes: 5 additions & 5 deletions repository/upload/lib.php
Original file line number Diff line number Diff line change
Expand Up @@ -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 <[email protected]>
* @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
* @package repository
* @subpackage upload
* @copyright 2009 Dongsheng Cai
* @author Dongsheng Cai <[email protected]>
* @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
*/

class repository_upload extends repository {
Expand Down
10 changes: 5 additions & 5 deletions repository/url/lib.php
Original file line number Diff line number Diff line change
Expand Up @@ -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 <[email protected]>
* @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
* @package repository
* @subpackage url
* @copyright 2009 Dongsheng Cai
* @author Dongsheng Cai <[email protected]>
* @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
*/

require_once(dirname(__FILE__).'/locallib.php');
Expand Down
Loading

0 comments on commit d078f6d

Please sign in to comment.