From daf10e29a35217f57c4315b3b16c8768453fdbdf Mon Sep 17 00:00:00 2001 From: misaochan Date: Fri, 19 Feb 2016 16:10:25 +1300 Subject: [PATCH] Documentation for Updater classes --- .../java/fr/free/nrw/commons/category/MethodAUpdater.java | 6 +++++- .../java/fr/free/nrw/commons/category/PrefixUpdater.java | 6 ++++++ 2 files changed, 11 insertions(+), 1 deletion(-) diff --git a/commons/src/main/java/fr/free/nrw/commons/category/MethodAUpdater.java b/commons/src/main/java/fr/free/nrw/commons/category/MethodAUpdater.java index 5c7ef5735..816f0c34e 100644 --- a/commons/src/main/java/fr/free/nrw/commons/category/MethodAUpdater.java +++ b/commons/src/main/java/fr/free/nrw/commons/category/MethodAUpdater.java @@ -1,6 +1,5 @@ package fr.free.nrw.commons.category; - import android.os.AsyncTask; import android.text.TextUtils; import android.util.Log; @@ -14,6 +13,11 @@ import java.util.ArrayList; import fr.free.nrw.commons.CommonsApplication; +/** + * Sends asynchronous queries to the Commons MediaWiki API to retrieve categories that are close to + * the keyword typed in by the user. The 'srsearch' action-specific parameter is used for this + * purpose. This class should be subclassed in CategorizationFragment.java to aggregate the results. + */ public class MethodAUpdater extends AsyncTask> { private String filter; diff --git a/commons/src/main/java/fr/free/nrw/commons/category/PrefixUpdater.java b/commons/src/main/java/fr/free/nrw/commons/category/PrefixUpdater.java index 589075837..a984f1a72 100644 --- a/commons/src/main/java/fr/free/nrw/commons/category/PrefixUpdater.java +++ b/commons/src/main/java/fr/free/nrw/commons/category/PrefixUpdater.java @@ -13,6 +13,12 @@ import java.util.ArrayList; import fr.free.nrw.commons.CommonsApplication; +/** + * Sends asynchronous queries to the Commons MediaWiki API to retrieve categories that share the + * same prefix as the keyword typed in by the user. The 'acprefix' action-specific parameter is used + * for this purpose. This class should be subclassed in CategorizationFragment.java to aggregate + * the results. + */ public class PrefixUpdater extends AsyncTask> { private String filter;