Skip to content

Commit

Permalink
Fix a few Javadoc typos
Browse files Browse the repository at this point in the history
  • Loading branch information
sebkur committed Feb 6, 2017
1 parent da2012b commit f4b3ef3
Show file tree
Hide file tree
Showing 21 changed files with 40 additions and 40 deletions.
Original file line number Diff line number Diff line change
Expand Up @@ -47,7 +47,7 @@ public enum Item {

/**
* A sane portion of the entire message, cut off at a provider determined limit.
* This should generaly be around 50kB.
* This should generally be around 50kB.
*/
BODY_SANE,

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -133,14 +133,14 @@ public void write(byte b[], int offset, int len) throws IOException {

/**
* Flushes this output stream and forces any buffered output bytes
* to be written out to the stream. If propogate is true, the wrapped
* to be written out to the stream. If propagate is true, the wrapped
* stream will also be flushed.
*
* @param propogate boolean flag to indicate whether the wrapped
* @param propagate boolean flag to indicate whether the wrapped
* OutputStream should also be flushed.
* @throws IOException if an I/O error occurs.
*/
private void flush(boolean propogate) throws IOException {
private void flush(boolean propagate) throws IOException {
int avail = base64.avail();
if (avail > 0) {
byte[] buf = new byte[avail];
Expand All @@ -149,7 +149,7 @@ private void flush(boolean propogate) throws IOException {
out.write(buf, 0, c);
}
}
if (propogate) {
if (propagate) {
out.flush();
}
}
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -133,7 +133,7 @@ public static boolean hasMissingParts(Part part) {
}


/** Traverse the MIME tree of a message an extract viewable parts. */
/** Traverse the MIME tree of a message and extract viewable parts. */
public static void findViewablesAndAttachments(Part part,
@Nullable List<Viewable> outputViewableParts, @Nullable List<Part> outputNonViewableParts)
throws MessagingException {
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -322,7 +322,7 @@ public boolean create(FolderType type) throws MessagingException {
* </p>
*
* @param messages
* The messages to copy to the specfied folder.
* The messages to copy to the specified folder.
* @param folder
* The name of the target folder.
*
Expand Down
2 changes: 1 addition & 1 deletion k9mail/src/main/java/com/fsck/k9/Account.java
Original file line number Diff line number Diff line change
Expand Up @@ -1468,7 +1468,7 @@ public synchronized void setPushPollOnConnect(boolean pushPollOnConnect) {
/**
* Are we storing out localStore on the SD-card instead of the local device
* memory?<br/>
* Only to be called durin initial account-setup!<br/>
* Only to be called during initial account-setup!<br/>
* Side-effect: changes {@link #mLocalStorageProviderId}.
*
* @param newStorageProviderId
Expand Down
2 changes: 1 addition & 1 deletion k9mail/src/main/java/com/fsck/k9/K9.java
Original file line number Diff line number Diff line change
Expand Up @@ -391,7 +391,7 @@ private static void setServicesEnabled(Context context, boolean enabled, Integer
}

/**
* Register BroadcastReceivers programmaticaly because doing it from manifest
* Register BroadcastReceivers programmatically because doing it from manifest
* would make K-9 auto-start. We don't want auto-start because the initialization
* sequence isn't safe while some events occur (SD card unmount).
*/
Expand Down
2 changes: 1 addition & 1 deletion k9mail/src/main/java/com/fsck/k9/activity/Accounts.java
Original file line number Diff line number Diff line change
Expand Up @@ -636,7 +636,7 @@ private void onCompose() {
* Show that account's inbox or folder-list
* or return false if the account is not available.
* @param account the account to open ({@link SearchAccount} or {@link Account})
* @return false if unsuccessfull
* @return false if unsuccessful
*/
private boolean onOpenAccount(BaseAccount account) {
if (account instanceof SearchAccount) {
Expand Down
4 changes: 2 additions & 2 deletions k9mail/src/main/java/com/fsck/k9/activity/FolderList.java
Original file line number Diff line number Diff line change
Expand Up @@ -1150,8 +1150,8 @@ public Filter getFilter() {
}

/**
* Filter to search for occurences of the search-expression in any place of the
* folder-name instead of doing jsut a prefix-search.
* Filter to search for occurrences of the search-expression in any place of the
* folder-name instead of doing just a prefix-search.
*
* @author Marcus@Wolschon.biz
*/
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -11,8 +11,8 @@
import com.fsck.k9.K9;

/**
* Filter to search for occurences of the search-expression in any place of the
* folder-name instead of doing jsut a prefix-search.
* Filter to search for occurrences of the search-expression in any place of the
* folder-name instead of doing just a prefix-search.
*
* @author Marcus@Wolschon.biz
*/
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -1776,7 +1776,7 @@ private void processPendingCommandsSynchronous(Account account) throws Messaging
* the local message. Once the local message is successfully processed it is deleted so
* that the server message will be synchronized down without an additional copy being
* created.
* TODO update the local message UID instead of deleteing it
* TODO update the local message UID instead of deleting it
*/
void processPendingAppend(PendingAppend command, Account account) throws MessagingException {
Folder remoteFolder = null;
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -4,8 +4,8 @@
import android.text.TextWatcher;

/**
* all methods empty - but this way we can have TextWatchers with less boilder-plate where
* we just override the methods we want and not always al 3
* all methods empty - but this way we can have TextWatchers with less boiler-plate where
* we just override the methods we want and not always all 3
*/
public class SimpleTextWatcher implements TextWatcher {
@Override
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -130,7 +130,7 @@ public void onMount(final String providerId) {
private Context context;

/**
* {@link ThreadLocal} to check whether a DB transaction is occuring in the
* {@link ThreadLocal} to check whether a DB transaction is occurring in the
* current {@link Thread}.
*
* @see #execute(boolean, DbCallback)
Expand Down Expand Up @@ -250,7 +250,7 @@ protected void unlockWrite(final String providerId) {
*
* <p>
* Can be instructed to start a transaction if none is currently active in
* the current thread. Callback will participe in any active transaction (no
* the current thread. Callback will participate in any active transaction (no
* inner transaction created).
* </p>
*
Expand Down
18 changes: 9 additions & 9 deletions k9mail/src/main/java/com/fsck/k9/mailstore/StorageManager.java
Original file line number Diff line number Diff line change
Expand Up @@ -85,7 +85,7 @@ public static interface StorageProvider {
boolean isSupported(Context context);

/**
* Return the {@link File} to the choosen email database file. The
* Return the {@link File} to the chosen email database file. The
* resulting {@link File} doesn't necessarily match an existing file on
* the filesystem.
*
Expand All @@ -98,7 +98,7 @@ public static interface StorageProvider {
File getDatabase(Context context, String id);

/**
* Return the {@link File} to the choosen attachment directory. The
* Return the {@link File} to the chosen attachment directory. The
* resulting {@link File} doesn't necessarily match an existing
* directory on the filesystem.
*
Expand All @@ -116,7 +116,7 @@ public static interface StorageProvider {
* @param context
* Never <code>null</code>.
* @return Whether the underlying storage returned by this provider is
* ready for read/write operations at the time of invokation.
* ready for read/write operations at the time of invocation.
*/
boolean isReady(Context context);

Expand Down Expand Up @@ -178,7 +178,7 @@ public abstract static class FixedStorageProviderBase implements StorageProvider
private File mRoot;

/**
* Choosen base directory
* Chosen base directory
*/
private File mApplicationDir;

Expand Down Expand Up @@ -246,7 +246,7 @@ public final File getRoot(Context context) {
* <p>
* This implementation is expected to work on every device since it's based
* on the regular Android API {@link Context#getDatabasePath(String)} and
* uses the resul to retrieve the DB path and the attachment directory path.
* uses the result to retrieve the DB path and the attachment directory path.
* </p>
*
* <p>
Expand Down Expand Up @@ -306,7 +306,7 @@ public File getRoot(Context context) {
* Strategy for accessing the storage as returned by
* {@link Environment#getExternalStorageDirectory()}. In order to be
* compliant with Android recommendation regarding application uninstalling
* and to prevent from cluttering the storage root, the choosen directory
* and to prevent from cluttering the storage root, the chosen directory
* will be
* <code>&lt;STORAGE_ROOT&gt;/Android/data/&lt;APPLICATION_PACKAGE_NAME&gt;/files/</code>
*
Expand All @@ -330,7 +330,7 @@ public static class ExternalStorageProvider implements StorageProvider {
private File mRoot;

/**
* Choosen base directory.
* Chosen base directory.
*/
private File mApplicationDirectory;

Expand Down Expand Up @@ -455,7 +455,7 @@ protected File computeRoot(Context context) {
}

/**
* Stores storage provider locking informations
* Stores storage provider locking information
*/
public static class SynchronizationAid {
/**
Expand Down Expand Up @@ -592,7 +592,7 @@ public File getDatabase(final String dbName, final String providerId) {
* Never <code>null</code>.
* @param providerId
* Never <code>null</code>.
* @return The resolved attachement directory for the given provider ID.
* @return The resolved attachment directory for the given provider ID.
*/
public File getAttachmentDirectory(final String dbName, final String providerId) {
StorageProvider provider = getProvider(providerId);
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -178,7 +178,7 @@ public static String flow(String text, boolean delSp, int width) {

/**
* Checks whether the char is part of a word.
* <p>RFC assert a word cannot be splitted (even if the length is greater than the maximum length).
* <p>RFC assert a word cannot be split (even if the length is greater than the maximum length).
*/
public static boolean isAlphaChar(String text, int index) {
// Note: a list of chars is available here:
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,7 @@ public class HtmlConverter {
private static final String GOOD_IRI_CHAR =
"a-zA-Z0-9\u00A0-\uD7FF\uF900-\uFDCF\uFDF0-\uFFEF";
/**
* Goegular expression to match all IANA top-level domains for WEB_URL.
* Regular expression to match all IANA top-level domains for WEB_URL.
* List accurate as of 2011/01/12. List taken from:
* http://data.iana.org/TLD/tlds-alpha-by-domain.txt
* This pattern is auto-generated by frameworks/base/common/tools/make-iana-tld-pattern.py
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@
import com.fsck.k9.BuildConfig;

/**
* Utillity definitions for Android applications to control the behavior of K-9 Mail. All such applications must declare the following permission:
* Utility definitions for Android applications to control the behavior of K-9 Mail. All such applications must declare the following permission:
* <uses-permission android:name="com.fsck.k9.permission.REMOTE_CONTROL"/>
* in their AndroidManifest.xml In addition, all applications sending remote control messages to K-9 Mail must
*
Expand Down
6 changes: 3 additions & 3 deletions k9mail/src/main/java/com/fsck/k9/search/LocalSearch.java
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@
* TODO implement a complete addAllowedFolder method
* TODO conflicting conditions check on add
* TODO duplicate condition checking?
* TODO assign each node a unique id that's used to retrieve it from the leaveset and remove.
* TODO assign each node a unique id that's used to retrieve it from the leafset and remove.
*
*/

Expand Down Expand Up @@ -51,7 +51,7 @@ public LocalSearch(String name) {
}

/**
* Use this constructor when you know what you'r doing. Normally it's only used
* Use this constructor when you know what you're doing. Normally it's only used
* when restoring these search objects from the database.
*
* @param name Name of the search
Expand Down Expand Up @@ -119,7 +119,7 @@ public void addAccountUuid(String uuid) {

/**
* Adds all the account uuids in the provided array to
* be matched by the seach.
* be matched by the search.
*
* @param accountUuids
*/
Expand Down
4 changes: 2 additions & 2 deletions k9mail/src/main/java/com/fsck/k9/service/CoreService.java
Original file line number Diff line number Diff line change
Expand Up @@ -110,7 +110,7 @@ public abstract class CoreService extends Service {
* @param context
* A {@link Context} instance. Never {@code null}.
* @param intent
* The {@link Intent} to add the wake lock registy ID as extra to. Never {@code null}.
* The {@link Intent} to add the wake lock registry ID as extra to. Never {@code null}.
* @param wakeLockId
* The wake lock registry ID of an existing wake lock or {@code null}.
* @param createIfNotExists
Expand Down Expand Up @@ -140,7 +140,7 @@ protected static void addWakeLockId(Context context, Intent intent, Integer wake
* @param context
* A {@link Context} instance. Never {@code null}.
* @param intent
* The {@link Intent} to add the wake lock registy ID as extra to. Never {@code null}.
* The {@link Intent} to add the wake lock registry ID as extra to. Never {@code null}.
*/
protected static void addWakeLock(Context context, Intent intent) {
TracingWakeLock wakeLock = acquireWakeLock(context, "CoreService addWakeLock",
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@
*
* <p>
* It is advised not to statically register (from AndroidManifest.xml) this
* receiver in order to avoid unecessary K-9 launch (which would defeat the
* receiver in order to avoid unnecessary K-9 launch (which would defeat the
* purpose of that receiver). Using AndroidManifest.xml instructs Android to
* launch K-9 if not running, defeating the purpose of this receiver. <br>
* The recommended way is to register this receiver using
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -35,7 +35,7 @@
*
* Usually ScrollView will capture all touch events once a drag has begun. In some cases,
* we want to delegate those touches to children as normal, even in the middle of a drag. This is
* useful when there are childviews like a WebView tha handles scrolling in the horizontal direction
* useful when there are childviews like a WebView that handles scrolling in the horizontal direction
* even while the ScrollView drags vertically.
*
* This is only tested to work for ScrollViews where the content scrolls in one direction.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -119,7 +119,7 @@ public class OpenPgpApi {
* boolean EXTRA_REQUEST_ASCII_ARMOR (request ascii armor for output)
* char[] EXTRA_PASSPHRASE (key passphrase)
* String EXTRA_ORIGINAL_FILENAME (original filename to be encrypted as metadata)
* boolean EXTRA_ENABLE_COMPRESSION (enable ZLIB compression, default ist true)
* boolean EXTRA_ENABLE_COMPRESSION (enable ZLIB compression, default is true)
*/
public static final String ACTION_ENCRYPT = "org.openintents.openpgp.action.ENCRYPT";

Expand All @@ -136,7 +136,7 @@ public class OpenPgpApi {
* boolean EXTRA_REQUEST_ASCII_ARMOR (request ascii armor for output)
* char[] EXTRA_PASSPHRASE (key passphrase)
* String EXTRA_ORIGINAL_FILENAME (original filename to be encrypted as metadata)
* boolean EXTRA_ENABLE_COMPRESSION (enable ZLIB compression, default ist true)
* boolean EXTRA_ENABLE_COMPRESSION (enable ZLIB compression, default is true)
*/
public static final String ACTION_SIGN_AND_ENCRYPT = "org.openintents.openpgp.action.SIGN_AND_ENCRYPT";

Expand Down

0 comments on commit f4b3ef3

Please sign in to comment.