aboutsummaryrefslogtreecommitdiffstats
path: root/main/src/cgeo/geocaching/sorting
diff options
context:
space:
mode:
Diffstat (limited to 'main/src/cgeo/geocaching/sorting')
-rw-r--r--main/src/cgeo/geocaching/sorting/AbstractCacheComparator.java5
1 files changed, 4 insertions, 1 deletions
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
*/