Jeroen De Dauw has uploaded a new change for review. https://gerrit.wikimedia.org/r/88739
Change subject: Update docs and @since tags ...................................................................... Update docs and @since tags Change-Id: I7a1111d97df42ed03cbeef9930cb54112de062ca --- M README.md M src/Wikibase/Query/Api/EntitiesByPropertyValue.php M src/Wikibase/Query/DIC/Builders/ByPropertyValueEntityFinderBuilder.php M src/Wikibase/Query/DIC/Builders/QueryInterfaceBuilder.php M src/Wikibase/Query/DIC/Builders/QueryStoreBuilder.php M src/Wikibase/Query/DIC/DependencyBuilder.php M src/Wikibase/Query/DIC/DependencyManager.php M src/Wikibase/Query/DIC/ExtensionAccess.php M src/Wikibase/Query/DIC/WikibaseQuery.php M src/Wikibase/Query/QueryEntityDeserializer.php M src/Wikibase/Query/QueryEntitySerializer.php M src/Wikibase/Query/Setup/ExtensionSetup.php M src/Wikibase/Query/Setup/HookSetup.php A src/Wikibase/Query/Setup/SchemaUpdater.php M src/Wikibase/Query/Setup/WikibaseQueryBuilder.php 15 files changed, 31 insertions(+), 24 deletions(-) git pull ssh://gerrit.wikimedia.org:29418/mediawiki/extensions/WikibaseQuery refs/changes/39/88739/1 diff --git a/README.md b/README.md index fe6a84a..6c0e117 100644 --- a/README.md +++ b/README.md @@ -17,11 +17,12 @@ ## Requirements * PHP 5.3 or later +* [Wikibase DataModel](https://github.com/wikimedia/mediawiki-extensions-WikibaseDataModel/blob/master/README.md) 0.5 or later * Wikibase Repo 0.5 or later -* Wikibase QueryEngine 0.1 or later -* Ask 1.x -* DataValues 0.1 or later -* Serialization 2.x +* [Wikibase QueryEngine](https://github.com/wikimedia/mediawiki-extensions-WikibaseQueryEngine/blob/master/README.md) 0.1 or later +* [Ask](https://github.com/wikimedia/mediawiki-extensions-Ask/blob/master/README.md) 1.x +* [DataValues](https://www.mediawiki.org/wiki/Extension:DataValues) 0.1 or later +* [Serialization](https://github.com/wikimedia/mediawiki-extensions-Serialization/blob/master/README.md) 2.x ## Installation @@ -42,6 +43,13 @@ } } +## Technical documentation + +All classes provided by WikibaseQuery reside in the Wikibase\Query namespace. + +Public classes and interfaces have an @since tag denoting the version since which they can be accessed. +Constructs without an @since tag are package private and should not be used by extensions. + ## Tests This library comes with a set up PHPUnit tests that cover all non-trivial code. You can run these diff --git a/src/Wikibase/Query/Api/EntitiesByPropertyValue.php b/src/Wikibase/Query/Api/EntitiesByPropertyValue.php index 2224da2..d764d46 100644 --- a/src/Wikibase/Query/Api/EntitiesByPropertyValue.php +++ b/src/Wikibase/Query/Api/EntitiesByPropertyValue.php @@ -8,8 +8,6 @@ use Wikibase\Query\DIC\ExtensionAccess; /** - * @since 0.1 - * * @licence GNU GPL v2+ * @author Jeroen De Dauw < jeroended...@gmail.com > */ diff --git a/src/Wikibase/Query/DIC/Builders/ByPropertyValueEntityFinderBuilder.php b/src/Wikibase/Query/DIC/Builders/ByPropertyValueEntityFinderBuilder.php index 017c453..2308760 100644 --- a/src/Wikibase/Query/DIC/Builders/ByPropertyValueEntityFinderBuilder.php +++ b/src/Wikibase/Query/DIC/Builders/ByPropertyValueEntityFinderBuilder.php @@ -10,8 +10,6 @@ use Wikibase\Repo\WikibaseRepo; /** - * @since 1.0 - * * @licence GNU GPL v2+ * @author Jeroen De Dauw < jeroended...@gmail.com > */ diff --git a/src/Wikibase/Query/DIC/Builders/QueryInterfaceBuilder.php b/src/Wikibase/Query/DIC/Builders/QueryInterfaceBuilder.php index 5fe27ef..18add69 100644 --- a/src/Wikibase/Query/DIC/Builders/QueryInterfaceBuilder.php +++ b/src/Wikibase/Query/DIC/Builders/QueryInterfaceBuilder.php @@ -9,8 +9,6 @@ use Wikibase\Query\DIC\DependencyManager; /** - * @since 1.0 - * * @licence GNU GPL v2+ * @author Jeroen De Dauw < jeroended...@gmail.com > */ diff --git a/src/Wikibase/Query/DIC/Builders/QueryStoreBuilder.php b/src/Wikibase/Query/DIC/Builders/QueryStoreBuilder.php index 301eb9e..d2e0f1c 100644 --- a/src/Wikibase/Query/DIC/Builders/QueryStoreBuilder.php +++ b/src/Wikibase/Query/DIC/Builders/QueryStoreBuilder.php @@ -14,8 +14,6 @@ use Wikibase\Repo\WikibaseRepo; /** - * @since 1.0 - * * @licence GNU GPL v2+ * @author Jeroen De Dauw < jeroended...@gmail.com > */ diff --git a/src/Wikibase/Query/DIC/DependencyBuilder.php b/src/Wikibase/Query/DIC/DependencyBuilder.php index 9e9793a..eaf7571 100644 --- a/src/Wikibase/Query/DIC/DependencyBuilder.php +++ b/src/Wikibase/Query/DIC/DependencyBuilder.php @@ -12,7 +12,7 @@ * * Class based on suggestions by Tobias Schlitt. * - * @since 1.0 + * @since 0.1 * * @licence GNU GPL v2+ * @author Jeroen De Dauw < jeroended...@gmail.com > diff --git a/src/Wikibase/Query/DIC/DependencyManager.php b/src/Wikibase/Query/DIC/DependencyManager.php index 9dd0163..ebf6a41 100644 --- a/src/Wikibase/Query/DIC/DependencyManager.php +++ b/src/Wikibase/Query/DIC/DependencyManager.php @@ -17,7 +17,7 @@ * * Class based on suggestions by Tobias Schlitt. * - * @since 1.0 + * @since 0.1 * * @licence GNU GPL v2+ * @author Jeroen De Dauw < jeroended...@gmail.com > diff --git a/src/Wikibase/Query/DIC/ExtensionAccess.php b/src/Wikibase/Query/DIC/ExtensionAccess.php index 53df066..3c291ec 100644 --- a/src/Wikibase/Query/DIC/ExtensionAccess.php +++ b/src/Wikibase/Query/DIC/ExtensionAccess.php @@ -10,7 +10,7 @@ * * Class based on suggestions by Tobias Schlitt. * - * @since 1.0 + * @since 0.1 * * @licence GNU GPL v2+ * @author Jeroen De Dauw < jeroended...@gmail.com > diff --git a/src/Wikibase/Query/DIC/WikibaseQuery.php b/src/Wikibase/Query/DIC/WikibaseQuery.php index b2250c3..65ab0b1 100644 --- a/src/Wikibase/Query/DIC/WikibaseQuery.php +++ b/src/Wikibase/Query/DIC/WikibaseQuery.php @@ -15,7 +15,7 @@ * * Class based on suggestions by Tobias Schlitt. * - * @since 1.0 + * @since 0.1 * * @licence GNU GPL v2+ * @author Jeroen De Dauw < jeroended...@gmail.com > diff --git a/src/Wikibase/Query/QueryEntityDeserializer.php b/src/Wikibase/Query/QueryEntityDeserializer.php index 43c4898..491e5ae 100644 --- a/src/Wikibase/Query/QueryEntityDeserializer.php +++ b/src/Wikibase/Query/QueryEntityDeserializer.php @@ -14,7 +14,7 @@ * TODO: The term deserialization code can become a strategy so this class * can be used for external representation deserialization as well. * - * @since 1.0 + * @since 0.1 * * @licence GNU GPL v2+ * @author Jeroen De Dauw < jeroended...@gmail.com > diff --git a/src/Wikibase/Query/QueryEntitySerializer.php b/src/Wikibase/Query/QueryEntitySerializer.php index 18b4d82..14437f2 100644 --- a/src/Wikibase/Query/QueryEntitySerializer.php +++ b/src/Wikibase/Query/QueryEntitySerializer.php @@ -7,7 +7,7 @@ use Wikibase\Entity; /** - * @since 1.0 + * @since 0.1 * * @licence GNU GPL v2+ * @author Jeroen De Dauw < jeroended...@gmail.com > diff --git a/src/Wikibase/Query/Setup/ExtensionSetup.php b/src/Wikibase/Query/Setup/ExtensionSetup.php index 4e6ace8..6feaaac 100644 --- a/src/Wikibase/Query/Setup/ExtensionSetup.php +++ b/src/Wikibase/Query/Setup/ExtensionSetup.php @@ -5,8 +5,6 @@ use Wikibase\Query\DIC\ExtensionAccess; /** - * @since 0.1 - * * @licence GNU GPL v2+ * @author Jeroen De Dauw < jeroended...@gmail.com > */ diff --git a/src/Wikibase/Query/Setup/HookSetup.php b/src/Wikibase/Query/Setup/HookSetup.php index a70c0eb..41518e1 100644 --- a/src/Wikibase/Query/Setup/HookSetup.php +++ b/src/Wikibase/Query/Setup/HookSetup.php @@ -8,8 +8,6 @@ use Wikibase\Query\DIC\ExtensionAccess; /** - * @since 0.1 - * * @licence GNU GPL v2+ * @author Jeroen De Dauw < jeroended...@gmail.com > */ diff --git a/src/Wikibase/Query/Setup/SchemaUpdater.php b/src/Wikibase/Query/Setup/SchemaUpdater.php new file mode 100644 index 0000000..a4ec6ca --- /dev/null +++ b/src/Wikibase/Query/Setup/SchemaUpdater.php @@ -0,0 +1,13 @@ +<?php + +namespace Wikibase\Query\Setup; + +/** + * @licence GNU GPL v2+ + * @author Jeroen De Dauw < jeroended...@gmail.com > + */ +class SchemaUpdater { + + // TODO + +} \ No newline at end of file diff --git a/src/Wikibase/Query/Setup/WikibaseQueryBuilder.php b/src/Wikibase/Query/Setup/WikibaseQueryBuilder.php index 80cd51a..baa1b5e 100644 --- a/src/Wikibase/Query/Setup/WikibaseQueryBuilder.php +++ b/src/Wikibase/Query/Setup/WikibaseQueryBuilder.php @@ -11,8 +11,6 @@ use Wikibase\Repo\WikibaseRepo; /** - * @since 0.1 - * * @licence GNU GPL v2+ * @author Jeroen De Dauw < jeroended...@gmail.com > */ -- To view, visit https://gerrit.wikimedia.org/r/88739 To unsubscribe, visit https://gerrit.wikimedia.org/r/settings Gerrit-MessageType: newchange Gerrit-Change-Id: I7a1111d97df42ed03cbeef9930cb54112de062ca Gerrit-PatchSet: 1 Gerrit-Project: mediawiki/extensions/WikibaseQuery Gerrit-Branch: master Gerrit-Owner: Jeroen De Dauw <jeroended...@gmail.com> _______________________________________________ MediaWiki-commits mailing list MediaWiki-commits@lists.wikimedia.org https://lists.wikimedia.org/mailman/listinfo/mediawiki-commits
