Remove various redundant '@license' tags in file headers

Redundant given this is the project-wide license already, especially in file headers that already include the GPL license header. This and other minor fixups based on feedback from Ie0cea0ef5027c7e5. * Add @file where missing. * Move @ingroup and @deprecated from file to class doc where needed. Change-Id: I7067abb7abee1f0c238cb2536e16192e946d8daa
2017-12-04 19:25:31 +00:00 · 2017-12-04 19:25:31 +00:00 · bee9f4db96
commit bee9f4db96
parent 92f9cb0551
31 changed files with 86 additions and 44 deletions
--- a/includes/MWGrants.php
+++ b/includes/MWGrants.php
@ -1,7 +1,5 @@
 <?php
 /**
- * Functions and constants to deal with grants
- *
 * 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
@ -16,6 +14,8 @@
 * 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
 */
 use MediaWiki\MediaWikiServices;

--- a/includes/changes/ChangesListBooleanFilter.php
+++ b/includes/changes/ChangesListBooleanFilter.php
@ -18,14 +18,13 @@
 * http://www.gnu.org/copyleft/gpl.html
 *
 * @file
- * @license GPL 2+
 * @author Matthew Flaschen
 */

 use Wikimedia\Rdbms\IDatabase;

 /**
- * An individual filter in a boolean group
+ * Represents a hide-based boolean filter (used on ChangesListSpecialPage and descendants)
 *
 * @since 1.29
 */
--- a/includes/changes/ChangesListFilter.php
+++ b/includes/changes/ChangesListFilter.php
@ -18,7 +18,6 @@
 * http://www.gnu.org/copyleft/gpl.html
 *
 * @file
- * @license GPL 2+
 * @author Matthew Flaschen
 */

--- a/includes/changes/ChangesListFilterGroup.php
+++ b/includes/changes/ChangesListFilterGroup.php
@ -18,7 +18,6 @@
 * http://www.gnu.org/copyleft/gpl.html
 *
 * @file
- * @license GPL 2+
 * @author Matthew Flaschen
 */

--- a/includes/changes/ChangesListStringOptionsFilterGroup.php
+++ b/includes/changes/ChangesListStringOptionsFilterGroup.php
@ -18,7 +18,6 @@
 * http://www.gnu.org/copyleft/gpl.html
 *
 * @file
- * @license GPL 2+
 * @author Matthew Flaschen
 */

--- a/includes/libs/rdbms/connectionmanager/ConnectionManager.php
+++ b/includes/libs/rdbms/connectionmanager/ConnectionManager.php
@ -1,4 +1,23 @@
 <?php
+/**
+ * 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
+ * @ingroup Database
+ */

 namespace Wikimedia\Rdbms;

@ -11,7 +30,6 @@ use InvalidArgumentException;
 *
 * @since 1.29
 *
- * @license GPL-2.0+
 * @author Addshore
 */
 class ConnectionManager {
--- a/includes/libs/rdbms/connectionmanager/SessionConsistentConnectionManager.php
+++ b/includes/libs/rdbms/connectionmanager/SessionConsistentConnectionManager.php
@ -1,4 +1,23 @@
 <?php
+/**
+ * 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
+ * @ingroup Database
+ */

 namespace Wikimedia\Rdbms;

@ -20,7 +39,6 @@ namespace Wikimedia\Rdbms;
 *
 * @since 1.29
 *
- * @license GPL-2.0+
 * @author Daniel Kinzler
 * @author Addshore
 */
--- a/includes/linkeddata/PageDataRequestHandler.php
+++ b/includes/linkeddata/PageDataRequestHandler.php
@ -1,4 +1,22 @@
 <?php
+/**
+ * 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
+ */

 use Wikimedia\Http\HttpAcceptParser;
 use Wikimedia\Http\HttpAcceptNegotiator;
@ -6,11 +24,9 @@ use Wikimedia\Http\HttpAcceptNegotiator;
 /**
 * Request handler implementing a data interface for mediawiki pages.
 *
- * @license GPL-2.0+
 * @author Daniel Kinzler
 * @author Amir Sarabadanai
 */
-
 class PageDataRequestHandler {

 	/**
--- a/includes/linker/LinkRenderer.php
+++ b/includes/linker/LinkRenderer.php
@ -16,7 +16,6 @@
 * http://www.gnu.org/copyleft/gpl.html
 *
 * @file
- * @license GPL-2.0+
 * @author Kunal Mehta <legoktm@member.fsf.org>
 */
 namespace MediaWiki\Linker;
--- a/includes/linker/LinkRendererFactory.php
+++ b/includes/linker/LinkRendererFactory.php
@ -16,7 +16,6 @@
 * http://www.gnu.org/copyleft/gpl.html
 *
 * @file
- * @license GPL-2.0+
 * @author Kunal Mehta <legoktm@member.fsf.org>
 */
 namespace MediaWiki\Linker;
--- a/includes/linker/LinkTarget.php
+++ b/includes/linker/LinkTarget.php
@ -16,7 +16,6 @@
 * http://www.gnu.org/copyleft/gpl.html
 *
 * @file
- * @license GPL 2+
 * @author Addshore
 */
 namespace MediaWiki\Linker;
--- a/includes/specials/SpecialPageData.php
+++ b/includes/specials/SpecialPageData.php
@ -1,11 +1,32 @@
 <?php
+/**
+ * Special page to act as an endpoint for accessing raw page data.
+ *
+ * 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
+ */

 /**
 * Special page to act as an endpoint for accessing raw page data.
 * The web server should generally be configured to make this accessible via a canonical URL/URI,
 * such as <http://my.domain.org/data/main/Foo>.
 *
- * @license GPL-2.0+
+ * @class
+ * @ingroup SpecialPage
 */
 class SpecialPageData extends SpecialPage {

--- a/includes/specials/formfields/Licenses.php
+++ b/includes/specials/formfields/Licenses.php
@ -21,7 +21,6 @@
 * @ingroup SpecialPage
 * @author Ævar Arnfjörð Bjarmason <avarab@gmail.com>
 * @copyright Copyright © 2005, Ævar Arnfjörð Bjarmason
- * @license http://www.gnu.org/copyleft/gpl.html GNU General Public License 2.0 or later
 */

 /**
--- a/includes/title/ForeignTitleFactory.php
+++ b/includes/title/ForeignTitleFactory.php
@ -16,7 +16,6 @@
 * http://www.gnu.org/copyleft/gpl.html
 *
 * @file
- * @license GPL 2+
 */

 /**
--- a/includes/title/ImportTitleFactory.php
+++ b/includes/title/ImportTitleFactory.php
@ -16,7 +16,6 @@
 * http://www.gnu.org/copyleft/gpl.html
 *
 * @file
- * @license GPL 2+
 */

 /**
--- a/includes/title/MediaWikiTitleCodec.php
+++ b/includes/title/MediaWikiTitleCodec.php
@ -1,6 +1,6 @@
 <?php
 /**
- * A codec for %MediaWiki page titles.
+ * A codec for MediaWiki page titles.
 *
 * 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
@ -18,7 +18,6 @@
 * http://www.gnu.org/copyleft/gpl.html
 *
 * @file
- * @license GPL 2+
 * @author Daniel Kinzler
 */
 use MediaWiki\Interwiki\InterwikiLookup;
@ -26,7 +25,7 @@ use MediaWiki\MediaWikiServices;
 use MediaWiki\Linker\LinkTarget;

 /**
- * A codec for %MediaWiki page titles.
+ * A codec for MediaWiki page titles.
 *
 * @note Normalization and validation is applied while parsing, not when formatting.
 * It's possible to construct a TitleValue with an invalid title, and use MediaWikiTitleCodec
--- a/includes/title/NaiveForeignTitleFactory.php
+++ b/includes/title/NaiveForeignTitleFactory.php
@ -16,7 +16,6 @@
 * http://www.gnu.org/copyleft/gpl.html
 *
 * @file
- * @license GPL 2+
 */

 /**
--- a/includes/title/NaiveImportTitleFactory.php
+++ b/includes/title/NaiveImportTitleFactory.php
@ -16,7 +16,6 @@
 * http://www.gnu.org/copyleft/gpl.html
 *
 * @file
- * @license GPL 2+
 */

 /**
--- a/includes/title/NamespaceAwareForeignTitleFactory.php
+++ b/includes/title/NamespaceAwareForeignTitleFactory.php
@ -16,7 +16,6 @@
 * http://www.gnu.org/copyleft/gpl.html
 *
 * @file
- * @license GPL 2+
 */

 /**
--- a/includes/title/NamespaceImportTitleFactory.php
+++ b/includes/title/NamespaceImportTitleFactory.php
@ -16,7 +16,6 @@
 * http://www.gnu.org/copyleft/gpl.html
 *
 * @file
- * @license GPL 2+
 */

 /**
--- a/includes/title/SubpageImportTitleFactory.php
+++ b/includes/title/SubpageImportTitleFactory.php
@ -16,7 +16,6 @@
 * http://www.gnu.org/copyleft/gpl.html
 *
 * @file
- * @license GPL 2+
 */

 /**
--- a/includes/title/TitleFormatter.php
+++ b/includes/title/TitleFormatter.php
@ -1,6 +1,6 @@
 <?php
 /**
- * A title formatter service for %MediaWiki.
+ * A title formatter service for MediaWiki.
 *
 * 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
@ -18,7 +18,6 @@
 * http://www.gnu.org/copyleft/gpl.html
 *
 * @file
- * @license GPL 2+
 * @author Daniel Kinzler
 */
 use MediaWiki\Linker\LinkTarget;
--- a/includes/title/TitleParser.php
+++ b/includes/title/TitleParser.php
@ -18,7 +18,6 @@
 * http://www.gnu.org/copyleft/gpl.html
 *
 * @file
- * @license GPL 2+
 * @author Daniel Kinzler
 */

--- a/includes/title/TitleValue.php
+++ b/includes/title/TitleValue.php
@ -1,6 +1,6 @@
 <?php
 /**
- * Representation of a page title within %MediaWiki.
+ * Representation of a page title within MediaWiki.
 *
 * 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
@ -18,14 +18,13 @@
 * http://www.gnu.org/copyleft/gpl.html
 *
 * @file
- * @license GPL 2+
 * @author Daniel Kinzler
 */
 use MediaWiki\Linker\LinkTarget;
 use Wikimedia\Assert\Assert;

 /**
- * Represents a page (or page fragment) title within %MediaWiki.
+ * Represents a page (or page fragment) title within MediaWiki.
 *
 * @note In contrast to Title, this is designed to be a plain value object. That is,
 * it is immutable, does not use global state, and causes no side effects.
--- a/tests/phpunit/includes/libs/http/HttpAcceptNegotiatorTest.php
+++ b/tests/phpunit/includes/libs/http/HttpAcceptNegotiatorTest.php
@ -5,7 +5,6 @@ use Wikimedia\Http\HttpAcceptNegotiator;
 /**
 * @covers Wikimedia\Http\HttpAcceptNegotiator
 *
- * @license GPL-2.0+
 * @author Daniel Kinzler
 */
 class HttpAcceptNegotiatorTest extends \PHPUnit_Framework_TestCase {
--- a/tests/phpunit/includes/libs/http/HttpAcceptParserTest.php
+++ b/tests/phpunit/includes/libs/http/HttpAcceptParserTest.php
@ -5,7 +5,6 @@ use Wikimedia\Http\HttpAcceptParser;
 /**
 * @covers Wikimedia\Http\HttpAcceptParser
 *
- * @license GPL-2.0+
 * @author Daniel Kinzler
 */
 class HttpAcceptParserTest extends \PHPUnit_Framework_TestCase {
--- a/tests/phpunit/includes/libs/rdbms/connectionmanager/ConnectionManagerTest.php
+++ b/tests/phpunit/includes/libs/rdbms/connectionmanager/ConnectionManagerTest.php
@ -10,7 +10,6 @@ use Wikimedia\Rdbms\ConnectionManager;
 /**
 * @covers Wikimedia\Rdbms\ConnectionManager
 *
- * @license GPL-2.0+
 * @author Daniel Kinzler
 */
 class ConnectionManagerTest extends \PHPUnit_Framework_TestCase {
--- a/tests/phpunit/includes/libs/rdbms/connectionmanager/SessionConsistentConnectionManagerTest.php
+++ b/tests/phpunit/includes/libs/rdbms/connectionmanager/SessionConsistentConnectionManagerTest.php
@ -10,7 +10,6 @@ use Wikimedia\Rdbms\SessionConsistentConnectionManager;
 /**
 * @covers Wikimedia\Rdbms\SessionConsistentConnectionManager
 *
- * @license GPL-2.0+
 * @author Daniel Kinzler
 */
 class SessionConsistentConnectionManagerTest extends \PHPUnit_Framework_TestCase {
--- a/tests/phpunit/includes/linkeddata/PageDataRequestHandlerTest.php
+++ b/tests/phpunit/includes/linkeddata/PageDataRequestHandlerTest.php
@ -2,10 +2,7 @@

 /**
 * @covers PageDataRequestHandler
- *
 * @group PageData
- *
- * @license GPL-2.0+
 */
 class PageDataRequestHandlerTest extends \MediaWikiTestCase {

--- a/tests/phpunit/includes/specials/SpecialPageDataTest.php
+++ b/tests/phpunit/includes/specials/SpecialPageDataTest.php
@ -2,12 +2,9 @@

 /**
 * @covers SpecialPageData
- *
 * @group Database
- *
 * @group SpecialPage
 *
- * @license GPL-2.0+
 * @author Daniel Kinzler
 */
 class SpecialPageDataTest extends SpecialPageTestBase {
--- a/tests/phpunit/languages/LanguageCodeTest.php
+++ b/tests/phpunit/languages/LanguageCodeTest.php
@ -2,10 +2,8 @@

 /**
 * @covers LanguageCode
- *
 * @group Language
 *
- * @license GPL-2.0+
 * @author Thiemo Kreuz
 */
 class LanguageCodeTest extends PHPUnit_Framework_TestCase {