jenkins-bot has submitted this change and it was merged.
Change subject: Documented the Classes ImportStringSource and ImportStreamSource
......................................................................
Documented the Classes ImportStringSource and ImportStreamSource
Added short descriptions for each class
Change-Id: I28d3dea76ab70326a1e16b7c41b1f3758f8648b8
---
M includes/Import.php
1 file changed, 5 insertions(+), 2 deletions(-)
Approvals:
Legoktm: Looks good to me, approved
TTO: Looks good to me, but someone else must approve
jenkins-bot: Verified
diff --git a/includes/Import.php b/includes/Import.php
index 5b86fec..daefb88 100644
--- a/includes/Import.php
+++ b/includes/Import.php
@@ -1652,7 +1652,10 @@
}
/**
- * @todo document (e.g. one-sentence class description).
+ * Used for importing XML dumps where the content of the dump is in a string.
+ * This class is ineffecient, and should only be used for small dumps.
+ * For larger dumps, ImportStreamSource should be used instead.
+ *
* @ingroup SpecialPage
*/
class ImportStringSource {
@@ -1681,7 +1684,7 @@
}
/**
- * @todo document (e.g. one-sentence class description).
+ * Imports a XML dump from a file (either from file upload, files on disk, or
HTTP)
* @ingroup SpecialPage
*/
class ImportStreamSource {
--
To view, visit https://gerrit.wikimedia.org/r/182333
To unsubscribe, visit https://gerrit.wikimedia.org/r/settings
Gerrit-MessageType: merged
Gerrit-Change-Id: I28d3dea76ab70326a1e16b7c41b1f3758f8648b8
Gerrit-PatchSet: 3
Gerrit-Project: mediawiki/core
Gerrit-Branch: master
Gerrit-Owner: McIntireEvan <[email protected]>
Gerrit-Reviewer: Legoktm <[email protected]>
Gerrit-Reviewer: McIntireEvan <[email protected]>
Gerrit-Reviewer: TTO <[email protected]>
Gerrit-Reviewer: jenkins-bot <>
_______________________________________________
MediaWiki-commits mailing list
[email protected]
https://lists.wikimedia.org/mailman/listinfo/mediawiki-commits
