jenkins-bot has submitted this change and it was merged.
Change subject: Add documentation for EntityContentDataCodec defaults
......................................................................
Add documentation for EntityContentDataCodec defaults
Change-Id: I172ccfa317f2ec0550cc106c0e22217342e3494f
---
M lib/includes/Store/EntityContentDataCodec.php
1 file changed, 10 insertions(+), 5 deletions(-)
Approvals:
Daniel Kinzler: Looks good to me, approved
jenkins-bot: Verified
diff --git a/lib/includes/Store/EntityContentDataCodec.php
b/lib/includes/Store/EntityContentDataCodec.php
index 6c1db13..f8d2c32 100644
--- a/lib/includes/Store/EntityContentDataCodec.php
+++ b/lib/includes/Store/EntityContentDataCodec.php
@@ -58,7 +58,8 @@
* @param Serializer $entitySerializer A service capable of serializing
EntityDocument objects.
* @param Deserializer $entityDeserializer A service capable of
deserializing EntityDocument
* objects.
- * @param int $maxBlobSize The maximum size of a blob to allow during
serialization/deserialization, in bytes.
+ * @param int $maxBlobSize The maximum size of a blob to allow during
+ * serialization/deserialization, in bytes. Set to 0 to disable the
check.
*/
public function __construct(
EntityIdParser $entityIdParser,
@@ -140,7 +141,8 @@
* @see EntityHandler::serializeContent()
*
* @param EntityDocument $entity
- * @param string|null $format The desired serialization format.
+ * @param string|null $format The desired serialization format. One of
the CONTENT_FORMAT_...
+ * constants or null for the default.
*
* @throws InvalidArgumentException If the format is not supported.
* @throws MWContentSerializationException
@@ -168,7 +170,8 @@
* @see EntityHandler::serializeContent()
*
* @param EntityRedirect $redirect
- * @param string|null $format The desired serialization format.
+ * @param string|null $format The desired serialization format. One of
the CONTENT_FORMAT_...
+ * constants or null for the default.
*
* @throws InvalidArgumentException If the format is not supported.
* @throws MWContentSerializationException
@@ -227,7 +230,8 @@
* @see EntityHandler::unserializeContent()
*
* @param string $blob
- * @param string|null $format The serialization format of $blob.
+ * @param string|null $format The serialization format of the data
blob. One of the
+ * CONTENT_FORMAT_... constants or null for the default.
*
* @throws InvalidArgumentException If the format is not supported.
* @throws MWContentSerializationException
@@ -265,7 +269,8 @@
* @see EntityHandler::unserializeContent()
*
* @param string $blob
- * @param string|null $format The serialization format of $blob.
+ * @param string|null $format The serialization format of the data
blob. One of the
+ * CONTENT_FORMAT_... constants or null for the default.
*
* @throws InvalidArgumentException If the format is not supported.
* @throws MWContentSerializationException If the array could not be
decoded.
--
To view, visit https://gerrit.wikimedia.org/r/255921
To unsubscribe, visit https://gerrit.wikimedia.org/r/settings
Gerrit-MessageType: merged
Gerrit-Change-Id: I172ccfa317f2ec0550cc106c0e22217342e3494f
Gerrit-PatchSet: 3
Gerrit-Project: mediawiki/extensions/Wikibase
Gerrit-Branch: master
Gerrit-Owner: Thiemo Mättig (WMDE) <thiemo.maet...@wikimedia.de>
Gerrit-Reviewer: Aude <aude.w...@gmail.com>
Gerrit-Reviewer: Daniel Kinzler <daniel.kinz...@wikimedia.de>
Gerrit-Reviewer: Hoo man <h...@online.de>
Gerrit-Reviewer: JanZerebecki <jan.wikime...@zerebecki.de>
Gerrit-Reviewer: Jonas Kress (WMDE) <jonas.kr...@wikimedia.de>
Gerrit-Reviewer: Thiemo Mättig (WMDE) <thiemo.maet...@wikimedia.de>
Gerrit-Reviewer: jenkins-bot <>
_______________________________________________
MediaWiki-commits mailing list
MediaWiki-commits@lists.wikimedia.org
https://lists.wikimedia.org/mailman/listinfo/mediawiki-commits
