From d17ca39f1581d07d99e6b0cf0a0103d9e2755d48 Mon Sep 17 00:00:00 2001 From: Evan McIntire Date: Tue, 30 Dec 2014 20:13:05 -0500 Subject: [PATCH] Documented the Classes ImportStringSource and ImportStreamSource Added short descriptions for each class Change-Id: I28d3dea76ab70326a1e16b7c41b1f3758f8648b8 --- includes/Import.php | 7 +++++-- 1 file changed, 5 insertions(+), 2 deletions(-) diff --git a/includes/Import.php b/includes/Import.php index 5b86fec848..daefb8804a 100644 --- a/includes/Import.php +++ b/includes/Import.php @@ -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 { -- 2.20.1