Fix unresolved references in Javadoc comments

ippschi · Sep 2, 2018 · 56882dc · 56882dc
1 parent 3af2e6c
commit 56882dc
Show file tree

Hide file tree

Showing 12 changed files with 9 additions and 28 deletions.
diff --git a/app/core/src/main/java/com/fsck/k9/K9.java b/app/core/src/main/java/com/fsck/k9/K9.java
@@ -359,7 +359,7 @@ public static void init(Context context) {
      * Using {@code SharedPreferences} should be a lot faster than opening all SQLite databases to
      * get the current database version.
      * </p><p>
-     * See {@link UpgradeDatabases} for a detailed explanation of the database upgrade process.
+     * See the class {@code UpgradeDatabases} for a detailed explanation of the database upgrade process.
      * </p>
      *
      * @see #areDatabasesUpToDate()

diff --git a/app/core/src/main/java/com/fsck/k9/crypto/OpenPgpApiHelper.java b/app/core/src/main/java/com/fsck/k9/crypto/OpenPgpApiHelper.java
@@ -13,8 +13,6 @@ public class OpenPgpApiHelper {
      *
      * @return A string with the following format:
      *         <code>display name &lt;user@example.com&gt;</code>
-     *
-     * @see org.openintents.openpgp.util.OpenPgpApi#EXTRA_ACCOUNT_NAME
      */
     public static String buildUserId(Identity identity) {
         StringBuilder sb = new StringBuilder();

diff --git a/app/core/src/main/java/com/fsck/k9/search/ConditionsTreeNode.java b/app/core/src/main/java/com/fsck/k9/search/ConditionsTreeNode.java
@@ -292,8 +292,8 @@ public List<ConditionsTreeNode> preorder() {
      *
      * This method only supports node arguments with a null parent node.
      *
-     * @param Node to add.
-     * @param Operator that will connect the new node with this one.
+     * @param node Node to add.
+     * @param op Operator that will connect the new node with this one.
      * @return New parent node, containing the operator.
      * @throws Exception Throws when the provided new node does not have a null parent.
      */

diff --git a/app/k9mail/src/main/java/com/fsck/k9/external/remotecontrol/K9RemoteControl.java b/app/k9mail/src/main/java/com/fsck/k9/external/remotecontrol/K9RemoteControl.java
@@ -3,6 +3,7 @@
 
 import android.app.Activity;
 import android.content.Context;
+import android.content.ContextWrapper;
 import android.content.Intent;
 
 import com.fsck.k9.BuildConfig;
@@ -29,7 +30,7 @@ public class K9RemoteControl {
      */
     public static String K9_REMOTE_CONTROL_PERMISSION = BuildConfig.APPLICATION_ID + ".permission.REMOTE_CONTROL";
     /**
-     * {@link Intent} Action to be sent to K-9 using {@link ContextWrapper.sendOrderedBroadcast} in order to fetch the list of configured Accounts.
+     * {@link Intent} Action to be sent to K-9 using {@link ContextWrapper#sendBroadcast(Intent)} in order to fetch the list of configured Accounts.
      * The responseData will contain two String[] with keys K9_ACCOUNT_UUIDS and K9_ACCOUNT_DESCRIPTIONS
      */
     public static String K9_REQUEST_ACCOUNTS = BuildConfig.APPLICATION_ID + ".K9RemoteControl.requestAccounts";

diff --git a/app/ui/src/main/java/com/fsck/k9/activity/misc/SwipeGestureDetector.java b/app/ui/src/main/java/com/fsck/k9/activity/misc/SwipeGestureDetector.java
@@ -91,7 +91,7 @@ public boolean onFling(MotionEvent e1, MotionEvent e2, float velocityX, float ve
      */
     public interface OnSwipeGestureListener {
         /**
-         * Called when a swipe from right to left is handled by {@link MyGestureDetector}.
+         * Called when a swipe from right to left is handled by {@link SwipeGestureDetector}.
          *
          * <p>See {@link OnGestureListener#onFling(MotionEvent, MotionEvent, float, float)}
          * for more information on the {@link MotionEvent}s being passed.</p>
@@ -104,7 +104,7 @@ public interface OnSwipeGestureListener {
         void onSwipeRightToLeft(final MotionEvent e1, final MotionEvent e2);
 
         /**
-         * Called when a swipe from left to right is handled by {@link MyGestureDetector}.
+         * Called when a swipe from left to right is handled by {@link SwipeGestureDetector}.
          *
          * <p>See {@link OnGestureListener#onFling(MotionEvent, MotionEvent, float, float)}
          * for more information on the {@link MotionEvent}s being passed.</p>

diff --git a/backend/imap/src/main/java/com/fsck/k9/backend/imap/ImapStoreUriCreator.java b/backend/imap/src/main/java/com/fsck/k9/backend/imap/ImapStoreUriCreator.java
@@ -20,8 +20,6 @@ public class ImapStoreUriCreator {
      *         The {@link ServerSettings} object that holds the server settings.
      *
      * @return An ImapStore URI that holds the same information as the {@code server} parameter.
-     *
-     * @see com.fsck.k9.mail.store.StoreConfig#getStoreUri()
      */
     public static String create(ServerSettings server) {
         String userEnc = encodeUtf8(server.username);

diff --git a/backend/pop3/src/main/java/com/fsck/k9/backend/pop3/Pop3StoreUriCreator.java b/backend/pop3/src/main/java/com/fsck/k9/backend/pop3/Pop3StoreUriCreator.java
@@ -19,8 +19,6 @@ public class Pop3StoreUriCreator {
      *         The {@link ServerSettings} object that holds the server settings.
      *
      * @return A Pop3Store URI that holds the same information as the {@code server} parameter.
-     *
-     * @see StoreConfig#getStoreUri()
      */
     public static String create(ServerSettings server) {
         String userEnc = encodeUtf8(server.username);

diff --git a/backend/webdav/src/main/java/com/fsck/k9/backend/webdav/WebDavStoreUriCreator.java b/backend/webdav/src/main/java/com/fsck/k9/backend/webdav/WebDavStoreUriCreator.java
@@ -17,7 +17,6 @@ public class WebDavStoreUriCreator {
      *
      * @param server The {@link ServerSettings} object that holds the server settings.
      * @return A WebDavStore URI that holds the same information as the {@code server} parameter.
-     * @see StoreConfig#getStoreUri()
      */
     public static String create(ServerSettings server) {
         String userEnc = encodeUtf8(server.username);

diff --git a/mail/common/src/main/java/com/fsck/k9/mail/Message.java b/mail/common/src/main/java/com/fsck/k9/mail/Message.java
@@ -226,13 +226,7 @@ protected void copy(Message destination) {
     /**
      * Creates a new {@code Message} object with the same content as this object.
      *
-     * <p>
-     * <strong>Note:</strong>
-     * This method was introduced as a hack to prevent {@code ConcurrentModificationException}s. It
-     * shouldn't be used unless absolutely necessary. See the comment in
-     * {@link com.fsck.k9.activity.MessageView.Listener#loadMessageForViewHeadersAvailable(com.fsck.k9.Account, String, String, Message)}
-     * for more information.
-     * </p>
+     * FIXME: Remove this method because it is no longer used.
      */
     @Override
     public abstract Message clone();

diff --git a/mail/common/src/main/java/com/fsck/k9/mail/internet/Viewable.java b/mail/common/src/main/java/com/fsck/k9/mail/internet/Viewable.java
@@ -7,7 +7,7 @@
 
 /**
  * Empty marker class interface the class hierarchy used by
- * {@link MessageExtractor#findViewablesAndAttachments(com.fsck.k9.mail.Part, java.util.List)}
+ * {@link MessageExtractor#findViewablesAndAttachments(Part, List, List)}
  *
  * @see Viewable.Text
  * @see Viewable.Html

diff --git a/...protocols/smtp/src/main/java/com/fsck/k9/mail/transport/smtp/SmtpTransportUriCreator.java b/...protocols/smtp/src/main/java/com/fsck/k9/mail/transport/smtp/SmtpTransportUriCreator.java
@@ -19,8 +19,6 @@ public class SmtpTransportUriCreator {
      *         The {@link ServerSettings} object that holds the server settings.
      *
      * @return A SmtpTransport URI that holds the same information as the {@code server} parameter.
-     *
-     * @see com.fsck.k9.mail.store.StoreConfig#getTransportUri()
      */
     public static String createSmtpUri(ServerSettings server) {
         String userEnc = (server.username != null) ?

diff --git a/.../openpgp-api-lib/openpgp-api/src/main/java/org/openintents/openpgp/util/OpenPgpUtils.java b/.../openpgp-api-lib/openpgp-api/src/main/java/org/openintents/openpgp/util/OpenPgpUtils.java
@@ -118,11 +118,6 @@ public static UserId splitUserId(final String userId) {
 
     /**
      * Returns a composed user id. Returns null if name is null!
-     *
-     * @param name
-     * @param email
-     * @param comment
-     * @return
      */
     public static String createUserId(UserId userId) {
         String userIdString = userId.name; // consider name a required value