From 2be10febf96c65a9899c2e1b1728c437d9d99f67 Mon Sep 17 00:00:00 2001 From: Tobias Baum Date: Mon, 22 Sep 2014 21:55:08 +0200 Subject: [PATCH] Added (still rather shallow) missing Javadocs for classes in BinaryAttachmentBody hierarchy --- src/com/fsck/k9/mail/store/local/BinaryAttachmentBody.java | 4 ++++ src/com/fsck/k9/mail/store/local/LocalAttachmentBody.java | 3 +++ src/com/fsck/k9/mail/store/local/TempFileBody.java | 3 +++ src/com/fsck/k9/mail/store/local/TempFileMessageBody.java | 4 ++++ 4 files changed, 14 insertions(+) diff --git a/src/com/fsck/k9/mail/store/local/BinaryAttachmentBody.java b/src/com/fsck/k9/mail/store/local/BinaryAttachmentBody.java index c03fceb0d..27eeb243e 100644 --- a/src/com/fsck/k9/mail/store/local/BinaryAttachmentBody.java +++ b/src/com/fsck/k9/mail/store/local/BinaryAttachmentBody.java @@ -12,6 +12,10 @@ import com.fsck.k9.mail.Body; import com.fsck.k9.mail.MessagingException; import com.fsck.k9.mail.filter.Base64OutputStream; +/** + * Superclass for attachments that contain binary data. + * The source for the data differs for the subclasses. + */ public abstract class BinaryAttachmentBody implements Body { protected String mEncoding; diff --git a/src/com/fsck/k9/mail/store/local/LocalAttachmentBody.java b/src/com/fsck/k9/mail/store/local/LocalAttachmentBody.java index 34772be95..faea07a6c 100644 --- a/src/com/fsck/k9/mail/store/local/LocalAttachmentBody.java +++ b/src/com/fsck/k9/mail/store/local/LocalAttachmentBody.java @@ -9,6 +9,9 @@ import android.net.Uri; import com.fsck.k9.mail.MessagingException; +/** + * An attachment whose contents are loaded from an URI. + */ public class LocalAttachmentBody extends BinaryAttachmentBody { private Application mApplication; private Uri mUri; diff --git a/src/com/fsck/k9/mail/store/local/TempFileBody.java b/src/com/fsck/k9/mail/store/local/TempFileBody.java index f093998d8..82720521e 100644 --- a/src/com/fsck/k9/mail/store/local/TempFileBody.java +++ b/src/com/fsck/k9/mail/store/local/TempFileBody.java @@ -8,6 +8,9 @@ import java.io.InputStream; import com.fsck.k9.mail.MessagingException; +/** + * An attachment whose contents are contained in a file. + */ public class TempFileBody extends BinaryAttachmentBody { private final File mFile; diff --git a/src/com/fsck/k9/mail/store/local/TempFileMessageBody.java b/src/com/fsck/k9/mail/store/local/TempFileMessageBody.java index 82188f485..1fdb03e4b 100644 --- a/src/com/fsck/k9/mail/store/local/TempFileMessageBody.java +++ b/src/com/fsck/k9/mail/store/local/TempFileMessageBody.java @@ -8,6 +8,10 @@ import org.apache.james.mime4j.util.MimeUtil; import com.fsck.k9.mail.CompositeBody; import com.fsck.k9.mail.MessagingException; +/** + * An attachment containing a body of type message/rfc822 + * whose contents are contained in a file. + */ public class TempFileMessageBody extends TempFileBody implements CompositeBody { public TempFileMessageBody(String filename) {