Documented the Classes ImportStringSource and ImportStreamSource
authorEvan McIntire <mcintire.evan@gmail.com>
Wed, 31 Dec 2014 01:13:05 +0000 (20:13 -0500)
committerEvan McIntire <mcintire.evan@gmail.com>
Wed, 31 Dec 2014 01:51:28 +0000 (20:51 -0500)
Added short descriptions for each class

Change-Id: I28d3dea76ab70326a1e16b7c41b1f3758f8648b8

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 {