Add restrictions documentation on favorite handling

2 files changed, 23 insertions, 1 deletions

diff --git a/main/src/cgeo/geocaching/connector/gc/GCConnector.java b/main/src/cgeo/geocaching/connector/gc/GCConnector.java
index 5de170b..b196504 100644
--- a/main/src/cgeo/geocaching/connector/gc/GCConnector.java
+++ b/main/src/cgeo/geocaching/connector/gc/GCConnector.java
@@ -149,6 +149,15 @@ public class GCConnector extends AbstractConnector implements ISearchByGeocode,
         return removed;
     }
 
+    /**
+     * Add a cache to the favorites list.
+     *
+     * This must not be called from the UI thread.
+     *
+     * @param cache the cache to add
+     * @return <code>true</code> if the cache was sucessfully added, <code>false</code> otherwise
+     */
+
     public static boolean addToFavorites(cgCache cache) {
         final boolean added = GCParser.addToFavorites(cache);
         if (added) {
@@ -157,6 +166,15 @@ public class GCConnector extends AbstractConnector implements ISearchByGeocode,
         return added;
     }
 
+    /**
+     * Remove a cache from the favorites list.
+     *
+     * This must not be called from the UI thread.
+     *
+     * @param cache the cache to add
+     * @return <code>true</code> if the cache was sucessfully added, <code>false</code> otherwise
+     */
+
     public static boolean removeFromFavorites(cgCache cache) {
         final boolean removed = GCParser.removeFromFavorites(cache);
         if (removed) {
diff --git a/main/src/cgeo/geocaching/connector/gc/GCParser.java b/main/src/cgeo/geocaching/connector/gc/GCParser.java
index c40d470..fd4e3fa 100644
--- a/main/src/cgeo/geocaching/connector/gc/GCParser.java
+++ b/main/src/cgeo/geocaching/connector/gc/GCParser.java
@@ -1204,6 +1204,8 @@ public abstract class GCParser {
     /**
      * Adds the cache to the favorites of the user.
      *
+     * This must not be called from the UI thread.
+     *
      * @param cache
      *            the cache to add
      * @return <code>false</code> if an error occurred, <code>true</code> otherwise
@@ -1234,7 +1236,9 @@ public abstract class GCParser {
     }
 
     /**
-     * Removes the cache from the Favorites
+     * Removes the cache from the favorites.
+     *
+     * This must not be called from the UI thread.
      *
      * @param cache
      *            the cache to remove