Lucas Werkmeister (WMDE) has uploaded a new change for review. (
https://gerrit.wikimedia.org/r/384510 )
Change subject: Add missing class documentation comments
......................................................................
Add missing class documentation comments
In preparation for the upcoming Wikibase CodeSniffer 0.2.0 upgrade.
Change-Id: Ie4ba1350dad1b8fd6d3c19b74e87a57a94c0fd3b
---
M WikibaseQualityConstraintsHooks.php
M includes/ConstraintCheck/ConstraintChecker.php
M includes/ConstraintReportFactory.php
M tests/phpunit/Fake/FakeChecker.php
M tests/phpunit/Fake/FakeCheckerTest.php
M tests/phpunit/Fake/InMemoryConstraintLookup.php
M tests/phpunit/Fake/InMemoryConstraintLookupTest.php
7 files changed, 46 insertions(+), 0 deletions(-)
git pull
ssh://gerrit.wikimedia.org:29418/mediawiki/extensions/WikibaseQualityConstraints
refs/changes/10/384510/1
diff --git a/WikibaseQualityConstraintsHooks.php
b/WikibaseQualityConstraintsHooks.php
index 6d87b57..e7bac7d 100644
--- a/WikibaseQualityConstraintsHooks.php
+++ b/WikibaseQualityConstraintsHooks.php
@@ -12,6 +12,12 @@
use Wikibase\DataModel\Entity\PropertyId;
use Wikibase\DataModel\Services\Diff\EntityDiff;
+/**
+ * Container for hook callbacks registered in extension.json.
+ *
+ * @package WikibaseQuality\ConstraintReport
+ * @license GNU GPL v2+
+ */
final class WikibaseQualityConstraintsHooks {
public static function onExtensionRegistration() {
diff --git a/includes/ConstraintCheck/ConstraintChecker.php
b/includes/ConstraintCheck/ConstraintChecker.php
index d10fb9a..fc8ad4d 100644
--- a/includes/ConstraintCheck/ConstraintChecker.php
+++ b/includes/ConstraintCheck/ConstraintChecker.php
@@ -8,6 +8,13 @@
use
WikibaseQuality\ConstraintReport\ConstraintCheck\Helper\SparqlHelperException;
use WikibaseQuality\ConstraintReport\ConstraintCheck\Result\CheckResult;
+/**
+ * Checks a constraint on some constraint checking context.
+ * Most implementations only support one constraint type.
+ *
+ * @package WikibaseQuality\ConstraintReport\ConstraintCheck
+ * @license GNU GPL v2+
+ */
interface ConstraintChecker {
/**
diff --git a/includes/ConstraintReportFactory.php
b/includes/ConstraintReportFactory.php
index 40c8be5..754fb29 100644
--- a/includes/ConstraintReportFactory.php
+++ b/includes/ConstraintReportFactory.php
@@ -44,6 +44,13 @@
use WikibaseQuality\ConstraintReport\ConstraintCheck\Helper\TypeCheckerHelper;
use Wikibase\DataModel\Services\Statement\StatementGuidParser;
+/**
+ * Factory for {@link DelegatingConstraintChecker}
+ * and {@link ConstraintRepository}.
+ *
+ * @package WikibaseQuality\ConstraintReport
+ * @license GNU GPL v2+
+ */
class ConstraintReportFactory {
/**
diff --git a/tests/phpunit/Fake/FakeChecker.php
b/tests/phpunit/Fake/FakeChecker.php
index fe88445..42a6aec 100644
--- a/tests/phpunit/Fake/FakeChecker.php
+++ b/tests/phpunit/Fake/FakeChecker.php
@@ -7,6 +7,12 @@
use WikibaseQuality\ConstraintReport\ConstraintCheck\Context\Context;
use WikibaseQuality\ConstraintReport\ConstraintCheck\Result\CheckResult;
+/**
+ * Constraint checker implementation that always returns results with a static
status.
+ *
+ * @package WikibaseQuality\ConstraintReport\Tests\Fake
+ * @license GNU GPL v2+
+ */
class FakeChecker implements ConstraintChecker {
/**
diff --git a/tests/phpunit/Fake/FakeCheckerTest.php
b/tests/phpunit/Fake/FakeCheckerTest.php
index 4c2c81e..b8901b9 100644
--- a/tests/phpunit/Fake/FakeCheckerTest.php
+++ b/tests/phpunit/Fake/FakeCheckerTest.php
@@ -6,6 +6,13 @@
use WikibaseQuality\ConstraintReport\Constraint;
use WikibaseQuality\ConstraintReport\ConstraintCheck\Context\Context;
+/**
+ * @covers \WikibaseQuality\ConstraintReport\Tests\Fake\FakeChecker
+ *
+ * @group WikibaseQualityConstraints
+ *
+ * @license GNU GPL v2+
+ */
class FakeCheckerTest extends \PHPUnit_Framework_TestCase {
public function testCheckConstraint_ResultContainsPassedContext() {
diff --git a/tests/phpunit/Fake/InMemoryConstraintLookup.php
b/tests/phpunit/Fake/InMemoryConstraintLookup.php
index e1b147c..5ac281c 100644
--- a/tests/phpunit/Fake/InMemoryConstraintLookup.php
+++ b/tests/phpunit/Fake/InMemoryConstraintLookup.php
@@ -7,6 +7,12 @@
use WikibaseQuality\ConstraintReport\ConstraintLookup;
use Wikimedia\Assert\Assert;
+/**
+ * Simple constraint lookup implentation backed by an array.
+ *
+ * @package WikibaseQuality\ConstraintReport\Tests\Fake
+ * @license GNU GPL v2+
+ */
class InMemoryConstraintLookup implements ConstraintLookup {
/**
diff --git a/tests/phpunit/Fake/InMemoryConstraintLookupTest.php
b/tests/phpunit/Fake/InMemoryConstraintLookupTest.php
index 84da92a..bca34d4 100644
--- a/tests/phpunit/Fake/InMemoryConstraintLookupTest.php
+++ b/tests/phpunit/Fake/InMemoryConstraintLookupTest.php
@@ -5,6 +5,13 @@
use Wikibase\DataModel\Entity\PropertyId;
use WikibaseQuality\ConstraintReport\Constraint;
+/**
+ * @covers
\WikibaseQuality\ConstraintReport\Tests\Fake\InMemoryConstraintLookupTest
+ *
+ * @group WikibaseQualityConstraints
+ *
+ * @license GNU GPL v2+
+ */
class InMemoryConstraintLookupTest extends \PHPUnit_Framework_TestCase {
public function testQuery_NewLookup_ReturnsEmptyArrayForProperty() {
--
To view, visit https://gerrit.wikimedia.org/r/384510
To unsubscribe, visit https://gerrit.wikimedia.org/r/settings
Gerrit-MessageType: newchange
Gerrit-Change-Id: Ie4ba1350dad1b8fd6d3c19b74e87a57a94c0fd3b
Gerrit-PatchSet: 1
Gerrit-Project: mediawiki/extensions/WikibaseQualityConstraints
Gerrit-Branch: master
Gerrit-Owner: Lucas Werkmeister (WMDE) <lucas.werkmeis...@wikimedia.de>
_______________________________________________
MediaWiki-commits mailing list
MediaWiki-commits@lists.wikimedia.org
https://lists.wikimedia.org/mailman/listinfo/mediawiki-commits
