From d42e2751db06d2221dd4e05ee6d2ec3ca3cbb2df Mon Sep 17 00:00:00 2001
From: Bananeweizen <bananeweizen@gmx.de>
Date: Tue, 10 Feb 2015 18:05:29 +0100
Subject: require Javadoc to have tag descriptions or no tags

---
 main/src/cgeo/geocaching/sorting/AbstractCacheComparator.java | 5 ++++-
 main/src/cgeo/geocaching/utils/AsyncTaskWithProgress.java     | 3 +++
 2 files changed, 7 insertions(+), 1 deletion(-)

(limited to 'main/src')

diff --git a/main/src/cgeo/geocaching/sorting/AbstractCacheComparator.java b/main/src/cgeo/geocaching/sorting/AbstractCacheComparator.java
index 917bb8a..d7c46e1 100644
--- a/main/src/cgeo/geocaching/sorting/AbstractCacheComparator.java
+++ b/main/src/cgeo/geocaching/sorting/AbstractCacheComparator.java
@@ -35,7 +35,10 @@ abstract class AbstractCacheComparator implements CacheComparator {
      * Check necessary preconditions (like missing fields) before running the comparison itself.
      * Caches not filling the conditions will be placed last, sorted by Geocode.
      *
-     * The default returns <code>true</code> and can be overridden if needed in child classes.
+     * The default implementation returns <code>true</code> and can be overridden if needed in sub classes.
+     * 
+     * @param cache
+     *            the cache to be sorted
      *
      * @return <code>true</code> if the cache holds the necessary data to be compared meaningfully
      */
diff --git a/main/src/cgeo/geocaching/utils/AsyncTaskWithProgress.java b/main/src/cgeo/geocaching/utils/AsyncTaskWithProgress.java
index 29aea63..c2edd24 100644
--- a/main/src/cgeo/geocaching/utils/AsyncTaskWithProgress.java
+++ b/main/src/cgeo/geocaching/utils/AsyncTaskWithProgress.java
@@ -89,6 +89,9 @@ public abstract class AsyncTaskWithProgress<Params, Result> extends AsyncTask<Pa
     /**
      * This method should typically be overridden by sub classes instead of {@link #onPostExecute(Object)}.
      *
+     * @param result
+     *            The result of the operation computed by {@link #doInBackground(Object...)}.
+     *
      */
     protected void onPostExecuteInternal(final Result result) {
         // empty by default
-- 
cgit v1.1