From 7b79d94515878de5ec64adb1bdf7686f805f3d60 Mon Sep 17 00:00:00 2001 From: Alexandre Emsenhuber Date: Sat, 14 Aug 2010 17:42:40 +0000 Subject: [PATCH] * Standardised file description headers * Added some descriptions * Added @file where needed --- includes/AuthPlugin.php | 40 +++++++++++-------- includes/CategoryPage.php | 7 +++- includes/Cdb.php | 5 +++ includes/Cdb_PHP.php | 3 +- includes/ChangesList.php | 14 ++++--- includes/ExternalEdit.php | 4 +- includes/ExternalUser.php | 37 ++++++++++-------- includes/Feed.php | 44 +++++++++++---------- includes/ImageFunctions.php | 6 +++ includes/OutputHandler.php | 5 +++ includes/ProxyTools.php | 1 + includes/StreamFile.php | 6 ++- includes/UserMailer.php | 4 +- includes/WebRequest.php | 39 ++++++++++--------- includes/WebResponse.php | 6 +++ includes/WebStart.php | 12 ++++-- includes/memcached-client.php | 73 ++++++++++++++++++----------------- 17 files changed, 181 insertions(+), 125 deletions(-) diff --git a/includes/AuthPlugin.php b/includes/AuthPlugin.php index 0cb25b9489..7dc9925962 100644 --- a/includes/AuthPlugin.php +++ b/includes/AuthPlugin.php @@ -1,21 +1,27 @@ -# http://www.mediawiki.org/ -# -# This program is free software; you can redistribute it and/or modify -# it under the terms of the GNU General Public License as published by -# the Free Software Foundation; either version 2 of the License, or -# (at your option) any later version. -# -# This program is distributed in the hope that it will be useful, -# but WITHOUT ANY WARRANTY; without even the implied warranty of -# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the -# GNU General Public License for more details. -# -# You should have received a copy of the GNU General Public License along -# with this program; if not, write to the Free Software Foundation, Inc., -# 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA. -# http://www.gnu.org/copyleft/gpl.html +/** + * Authentication plugin interface + * + * Copyright © 2004 Brion Vibber + * http://www.mediawiki.org/ + * + * This program is free software; you can redistribute it and/or modify + * it under the terms of the GNU General Public License as published by + * the Free Software Foundation; either version 2 of the License, or + * (at your option) any later version. + * + * This program is distributed in the hope that it will be useful, + * but WITHOUT ANY WARRANTY; without even the implied warranty of + * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the + * GNU General Public License for more details. + * + * You should have received a copy of the GNU General Public License along + * with this program; if not, write to the Free Software Foundation, Inc., + * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA. + * http://www.gnu.org/copyleft/gpl.html + * + * @file + */ /** * Authentication plugin interface. Instantiate a subclass of AuthPlugin diff --git a/includes/CategoryPage.php b/includes/CategoryPage.php index 287efcf240..5f42fe7f92 100644 --- a/includes/CategoryPage.php +++ b/includes/CategoryPage.php @@ -1,14 +1,17 @@ */ @@ -15,7 +18,6 @@ * and save the modified data back to the server. * */ - class ExternalEdit { function __construct( $article, $mode ) { diff --git a/includes/ExternalUser.php b/includes/ExternalUser.php index 65dae61795..d1eff91633 100644 --- a/includes/ExternalUser.php +++ b/includes/ExternalUser.php @@ -1,21 +1,24 @@ -# http://www.mediawiki.org/ -# -# This program is free software; you can redistribute it and/or modify -# it under the terms of the GNU General Public License as published by -# the Free Software Foundation; either version 2 of the License, or -# (at your option) any later version. -# -# This program is distributed in the hope that it will be useful, -# but WITHOUT ANY WARRANTY; without even the implied warranty of -# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the -# GNU General Public License for more details. -# -# You should have received a copy of the GNU General Public License along -# with this program; if not, write to the Free Software Foundation, Inc., -# 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA. -# http://www.gnu.org/copyleft/gpl.html - /** - * @defgroup Feed Feed - * * Basic support for outputting syndication feeds in RSS, other formats. + * * Contain a feed class as well as classes to build rss / atom ... feeds * Available feeds are defined in Defines.php * + * Copyright © 2004 Brion Vibber + * http://www.mediawiki.org/ + * + * This program is free software; you can redistribute it and/or modify + * it under the terms of the GNU General Public License as published by + * the Free Software Foundation; either version 2 of the License, or + * (at your option) any later version. + * + * This program is distributed in the hope that it will be useful, + * but WITHOUT ANY WARRANTY; without even the implied warranty of + * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the + * GNU General Public License for more details. + * + * You should have received a copy of the GNU General Public License along + * with this program; if not, write to the Free Software Foundation, Inc., + * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA. + * http://www.gnu.org/copyleft/gpl.html + * * @file */ +/** + * @defgroup Feed Feed + */ + /** * A base class for basic support for outputting syndication feeds in RSS and other formats. * diff --git a/includes/ImageFunctions.php b/includes/ImageFunctions.php index 5f01ab6ef8..467624cc11 100644 --- a/includes/ImageFunctions.php +++ b/includes/ImageFunctions.php @@ -1,4 +1,10 @@ * @author * @author Tim Starling - * */ diff --git a/includes/WebRequest.php b/includes/WebRequest.php index e39a576a7a..117f4056b0 100644 --- a/includes/WebRequest.php +++ b/includes/WebRequest.php @@ -1,27 +1,28 @@ + * http://www.mediawiki.org/ + * + * This program is free software; you can redistribute it and/or modify + * it under the terms of the GNU General Public License as published by + * the Free Software Foundation; either version 2 of the License, or + * (at your option) any later version. + * + * This program is distributed in the hope that it will be useful, + * but WITHOUT ANY WARRANTY; without even the implied warranty of + * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the + * GNU General Public License for more details. + * + * You should have received a copy of the GNU General Public License along + * with this program; if not, write to the Free Software Foundation, Inc., + * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA. + * http://www.gnu.org/copyleft/gpl.html + * + * @file */ -# Copyright (C) 2003 Brion Vibber -# http://www.mediawiki.org/ -# -# This program is free software; you can redistribute it and/or modify -# it under the terms of the GNU General Public License as published by -# the Free Software Foundation; either version 2 of the License, or -# (at your option) any later version. -# -# This program is distributed in the hope that it will be useful, -# but WITHOUT ANY WARRANTY; without even the implied warranty of -# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the -# GNU General Public License for more details. -# -# You should have received a copy of the GNU General Public License along -# with this program; if not, write to the Free Software Foundation, Inc., -# 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA. -# http://www.gnu.org/copyleft/gpl.html - - /** * The WebRequest class encapsulates getting at data passed in the * URL or via a POSTed form, handling remove of "magic quotes" slashes, diff --git a/includes/WebResponse.php b/includes/WebResponse.php index f7d57e41c1..2b1ec04cb9 100644 --- a/includes/WebResponse.php +++ b/includes/WebResponse.php @@ -1,4 +1,10 @@ | -// | All rights reserved. | -// | | -// | Redistribution and use in source and binary forms, with or without | -// | modification, are permitted provided that the following conditions | -// | are met: | -// | | -// | 1. Redistributions of source code must retain the above copyright | -// | notice, this list of conditions and the following disclaimer. | -// | 2. Redistributions in binary form must reproduce the above copyright | -// | notice, this list of conditions and the following disclaimer in the | -// | documentation and/or other materials provided with the distribution. | -// | | -// | THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR | -// | IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES | -// | OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. | -// | IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT, | -// | INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT | -// | NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, | -// | DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY | -// | THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT | -// | (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF | -// | THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. | -// +---------------------------------------------------------------------------+ -// | Author: Ryan T. Dean | -// | Heavily influenced by the Perl memcached client by Brad Fitzpatrick. | -// | Permission granted by Brad Fitzpatrick for relicense of ported Perl | -// | client logic under 2-clause BSD license. | -// +---------------------------------------------------------------------------+ -// -// $TCAnet$ -// +/** + * +---------------------------------------------------------------------------+ + * | memcached client, PHP | + * +---------------------------------------------------------------------------+ + * | Copyright (c) 2003 Ryan T. Dean | + * | All rights reserved. | + * | | + * | Redistribution and use in source and binary forms, with or without | + * | modification, are permitted provided that the following conditions | + * | are met: | + * | | + * | 1. Redistributions of source code must retain the above copyright | + * | notice, this list of conditions and the following disclaimer. | + * | 2. Redistributions in binary form must reproduce the above copyright | + * | notice, this list of conditions and the following disclaimer in the | + * | documentation and/or other materials provided with the distribution. | + * | | + * | THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR | + * | IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES | + * | OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. | + * | IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT, | + * | INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT | + * | NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, | + * | DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY | + * | THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT | + * | (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF | + * | THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. | + * +---------------------------------------------------------------------------+ + * | Author: Ryan T. Dean | + * | Heavily influenced by the Perl memcached client by Brad Fitzpatrick. | + * | Permission granted by Brad Fitzpatrick for relicense of ported Perl | + * | client logic under 2-clause BSD license. | + * +---------------------------------------------------------------------------+ + * + * @file + * $TCAnet$ + */ /** * This is the PHP client for memcached - a distributed memory cache daemon. -- 2.20.1