Merge "Documented the Classes ImportStringSource and ImportStreamSource"
authorjenkins-bot <jenkins-bot@gerrit.wikimedia.org>
Wed, 31 Dec 2014 02:00:57 +0000 (02:00 +0000)
committerGerrit Code Review <gerrit@wikimedia.org>
Wed, 31 Dec 2014 02:00:57 +0000 (02:00 +0000)
includes/Import.php

index 5b86fec..daefb88 100644 (file)
@@ -1652,7 +1652,10 @@ class WikiRevision {
 }
 
 /**
- * @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 @@ class ImportStringSource {
 }
 
 /**
- * @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 {