[MediaWiki-commits] [Gerrit] mediawiki/core[master]: A few doc comment fixups

2017-12-04 Thread jenkins-bot (Code Review) 
jenkins-bot has submitted this change and it was merged. ( 
https://gerrit.wikimedia.org/r/394903 )

Change subject: A few doc comment fixups
..


A few doc comment fixups

* Remove some creation dates, they are not protected by GPL
* Remove duplicate @defgroup API
* Remove @ingroup from some @file doc comments on class files. It is not
  useful to list class files alongside classes in the doxygen module menu.
  Add @ingroup to some more class files that had @ingroup on their file,
  that was probably the author's intent.
* In PackedOverlayImageGallery, use the file comment as a class comment
* Don't put @defgroup and @file in the same comment. @defgroup makes the
  whole doc comment describe the group.
* Instead of putting AnsiTermColorer in two groups, use hierarchical
  groups.

Change-Id: If54f6e0b2bc1ea6de42045885cf836ee67b8e961
---
M includes/api/ApiImport.php
M includes/api/ApiOpenSearch.php
M includes/api/ApiRsd.php
M includes/api/ApiUsageException.php
M includes/deferred/CdnCacheUpdate.php
M includes/gallery/PackedOverlayImageGallery.php
M includes/installer/PhpBugTests.php
M includes/jobqueue/JobSpecification.php
M includes/jobqueue/aggregator/JobQueueAggregator.php
M includes/libs/rdbms/database/IDatabase.php
M includes/libs/rdbms/database/IMaintainableDatabase.php
M includes/libs/rdbms/exception/DBExpectedError.php
M includes/libs/rdbms/loadbalancer/LoadBalancer.php
M includes/specials/SpecialUploadStash.php
M includes/upload/UploadStash.php
M languages/classes/LanguageEn.php
M languages/classes/LanguageGan.php
M maintenance/term/MWTerm.php
18 files changed, 67 insertions(+), 31 deletions(-)

Approvals:
  Krinkle: Looks good to me, approved
  jenkins-bot: Verified



diff --git a/includes/api/ApiImport.php b/includes/api/ApiImport.php
index a0f0a8d..822711a 100644
--- a/includes/api/ApiImport.php
+++ b/includes/api/ApiImport.php
@@ -1,9 +1,5 @@
 .@gmail.com"
  *
  * This program is free software; you can redistribute it and/or modify
diff --git a/includes/api/ApiOpenSearch.php b/includes/api/ApiOpenSearch.php
index 419fd14..416fc7f 100644
--- a/includes/api/ApiOpenSearch.php
+++ b/includes/api/ApiOpenSearch.php
@@ -1,7 +1,5 @@
 @gmail.com"
  * Copyright © 2008 Brion Vibber 
  * Copyright © 2014 Wikimedia Foundation and contributors
@@ -382,6 +380,9 @@
}
 }
 
+/**
+ * @ingroup API
+ */
 class ApiOpenSearchFormatJson extends ApiFormatJson {
private $warningsAsError = false;
 
diff --git a/includes/api/ApiRsd.php b/includes/api/ApiRsd.php
index fdc62a8..f20d1c6 100644
--- a/includes/api/ApiRsd.php
+++ b/includes/api/ApiRsd.php
@@ -3,8 +3,6 @@
 /**
  * API for MediaWiki 1.17+
  *
- * Created on October 26, 2010
- *
  * Copyright © 2010 Bryan Tong Minh and Brion Vibber
  *
  * This program is free software; you can redistribute it and/or modify
diff --git a/includes/api/ApiUsageException.php 
b/includes/api/ApiUsageException.php
index 4196add..c200dcb 100644
--- a/includes/api/ApiUsageException.php
+++ b/includes/api/ApiUsageException.php
@@ -16,7 +16,6 @@
  * http://www.gnu.org/copyleft/gpl.html
  *
  * @file
- * @defgroup API API
  */
 
 /**
diff --git a/includes/deferred/CdnCacheUpdate.php 
b/includes/deferred/CdnCacheUpdate.php
index 7fafc0e..301c4f3 100644
--- a/includes/deferred/CdnCacheUpdate.php
+++ b/includes/deferred/CdnCacheUpdate.php
@@ -18,7 +18,6 @@
  * http://www.gnu.org/copyleft/gpl.html
  *
  * @file
- * @ingroup Cache
  */
 
 use Wikimedia\Assert\Assert;
diff --git a/includes/gallery/PackedOverlayImageGallery.php 
b/includes/gallery/PackedOverlayImageGallery.php
index db8ce68..0a5a457 100644
--- a/includes/gallery/PackedOverlayImageGallery.php
+++ b/includes/gallery/PackedOverlayImageGallery.php
@@ -1,8 +1,5 @@
 http://www.gnu.org/copyleft/gpl.html
  *
  * @file
- * @defgroup PHPBugTests PHP known bugs tests
  */
 
 /**
+ * @defgroup PHPBugTests PHP known bugs tests
+ */
+/**
  * Test for PHP+libxml2 bug which breaks XML input subtly with certain 
versions.
  * Known fixed with PHP 5.2.9 + libxml2-2.7.3
  * @see https://bugs.php.net/bug.php?id=45996
diff --git a/includes/jobqueue/JobSpecification.php 
b/includes/jobqueue/JobSpecification.php
index d844795..b62b83c 100644
--- a/includes/jobqueue/JobSpecification.php
+++ b/includes/jobqueue/JobSpecification.php
@@ -18,7 +18,6 @@
  * http://www.gnu.org/copyleft/gpl.html
  *
  * @file
- * @ingroup JobQueue
  */
 
 /**
diff --git a/includes/jobqueue/aggregator/JobQueueAggregator.php 
b/includes/jobqueue/aggregator/JobQueueAggregator.php
index f26beee..433de93 100644
--- a/includes/jobqueue/aggregator/JobQueueAggregator.php
+++ b/includes/jobqueue/aggregator/JobQueueAggregator.php
@@ -158,6 +158,9 @@
}
 }
 
+/**
+ * @ingroup JobQueue
+ */
 class JobQueueAggregatorNull extends JobQueueAggregator {
protected function doNotifyQueueEmpty( $wiki, $type ) {
return true;
diff --git

[MediaWiki-commits] [Gerrit] mediawiki/core[master]: A few doc comment fixups

2017-12-03 Thread Tim Starling (Code Review) 
Tim Starling has uploaded a new change for review. ( 
https://gerrit.wikimedia.org/r/394903 )

Change subject: A few doc comment fixups
..

A few doc comment fixups

* Remove some creation dates, they are not protected by GPL
* Remove duplicate @defgroup API
* Remove @ingroup from some @file doc comments on class files. It is not
  useful to list class files alongside classes in the doxygen module menu.
  Add @ingroup to some more class files that had @ingroup on their file,
  that was probably the author's intent.
* In PackedOverlayImageGallery, use the file comment as a class comment
* Don't put @defgroup and @file in the same comment. @defgroup makes the
  whole doc comment describe the group.
* Instead of putting AnsiTermColorer in two groups, use hierarchical
  groups.

Change-Id: If54f6e0b2bc1ea6de42045885cf836ee67b8e961
---
M includes/api/ApiImport.php
M includes/api/ApiOpenSearch.php
M includes/api/ApiRsd.php
M includes/api/ApiUsageException.php
M includes/deferred/CdnCacheUpdate.php
M includes/gallery/PackedOverlayImageGallery.php
M includes/installer/PhpBugTests.php
M includes/jobqueue/JobSpecification.php
M includes/jobqueue/aggregator/JobQueueAggregator.php
M includes/libs/rdbms/database/IDatabase.php
M includes/libs/rdbms/database/IMaintainableDatabase.php
M includes/libs/rdbms/exception/DBExpectedError.php
M includes/libs/rdbms/loadbalancer/LoadBalancer.php
M includes/specials/SpecialUploadStash.php
M includes/upload/UploadStash.php
M languages/classes/LanguageEn.php
M languages/classes/LanguageGan.php
M maintenance/term/MWTerm.php
18 files changed, 67 insertions(+), 31 deletions(-)


  git pull ssh://gerrit.wikimedia.org:29418/mediawiki/core 
refs/changes/03/394903/1

diff --git a/includes/api/ApiImport.php b/includes/api/ApiImport.php
index a0f0a8d..822711a 100644
--- a/includes/api/ApiImport.php
+++ b/includes/api/ApiImport.php
@@ -1,9 +1,5 @@
 .@gmail.com"
  *
  * This program is free software; you can redistribute it and/or modify
diff --git a/includes/api/ApiOpenSearch.php b/includes/api/ApiOpenSearch.php
index 419fd14..416fc7f 100644
--- a/includes/api/ApiOpenSearch.php
+++ b/includes/api/ApiOpenSearch.php
@@ -1,7 +1,5 @@
 @gmail.com"
  * Copyright © 2008 Brion Vibber 
  * Copyright © 2014 Wikimedia Foundation and contributors
@@ -382,6 +380,9 @@
}
 }
 
+/**
+ * @ingroup API
+ */
 class ApiOpenSearchFormatJson extends ApiFormatJson {
private $warningsAsError = false;
 
diff --git a/includes/api/ApiRsd.php b/includes/api/ApiRsd.php
index fdc62a8..f20d1c6 100644
--- a/includes/api/ApiRsd.php
+++ b/includes/api/ApiRsd.php
@@ -3,8 +3,6 @@
 /**
  * API for MediaWiki 1.17+
  *
- * Created on October 26, 2010
- *
  * Copyright © 2010 Bryan Tong Minh and Brion Vibber
  *
  * This program is free software; you can redistribute it and/or modify
diff --git a/includes/api/ApiUsageException.php 
b/includes/api/ApiUsageException.php
index 4196add..c200dcb 100644
--- a/includes/api/ApiUsageException.php
+++ b/includes/api/ApiUsageException.php
@@ -16,7 +16,6 @@
  * http://www.gnu.org/copyleft/gpl.html
  *
  * @file
- * @defgroup API API
  */
 
 /**
diff --git a/includes/deferred/CdnCacheUpdate.php 
b/includes/deferred/CdnCacheUpdate.php
index 7fafc0e..301c4f3 100644
--- a/includes/deferred/CdnCacheUpdate.php
+++ b/includes/deferred/CdnCacheUpdate.php
@@ -18,7 +18,6 @@
  * http://www.gnu.org/copyleft/gpl.html
  *
  * @file
- * @ingroup Cache
  */
 
 use Wikimedia\Assert\Assert;
diff --git a/includes/gallery/PackedOverlayImageGallery.php 
b/includes/gallery/PackedOverlayImageGallery.php
index db8ce68..0a5a457 100644
--- a/includes/gallery/PackedOverlayImageGallery.php
+++ b/includes/gallery/PackedOverlayImageGallery.php
@@ -1,8 +1,5 @@
 http://www.gnu.org/copyleft/gpl.html
  *
  * @file
- * @defgroup PHPBugTests PHP known bugs tests
  */
 
 /**
+ * @defgroup PHPBugTests PHP known bugs tests
+ */
+/**
  * Test for PHP+libxml2 bug which breaks XML input subtly with certain 
versions.
  * Known fixed with PHP 5.2.9 + libxml2-2.7.3
  * @see https://bugs.php.net/bug.php?id=45996
diff --git a/includes/jobqueue/JobSpecification.php 
b/includes/jobqueue/JobSpecification.php
index d844795..b62b83c 100644
--- a/includes/jobqueue/JobSpecification.php
+++ b/includes/jobqueue/JobSpecification.php
@@ -18,7 +18,6 @@
  * http://www.gnu.org/copyleft/gpl.html
  *
  * @file
- * @ingroup JobQueue
  */
 
 /**
diff --git a/includes/jobqueue/aggregator/JobQueueAggregator.php 
b/includes/jobqueue/aggregator/JobQueueAggregator.php
index f26beee..433de93 100644
--- a/includes/jobqueue/aggregator/JobQueueAggregator.php
+++ b/includes/jobqueue/aggregator/JobQueueAggregator.php
@@ -158,6 +158,9 @@
}
 }
 
+/**
+ * @ingroup JobQueue
+ */
 class JobQueueAggregatorNull extends JobQueueAggregator {
protected function doNotifyQueueEmpty( $wiki, $type ) {
return true;
diff --git