From 2ddacc7ab9249dcbe5d6bff8969fb0718add92df Mon Sep 17 00:00:00 2001 From: Xiao Bao Clark Date: Sun, 9 Aug 2015 12:27:24 +1000 Subject: [PATCH] Fixed various errors in JavaDoc references. --- .../android/vanilla/FullPlaybackActivity.java | 2 +- .../android/vanilla/NewPlaylistDialog.java | 1 - .../android/vanilla/Playlist.java | 2 +- .../android/dslv/DragSortController.java | 12 ++++----- .../android/dslv/DragSortCursorAdapter.java | 5 ++-- .../mobeta/android/dslv/DragSortListView.java | 9 +++---- .../dslv/ResourceDragSortCursorAdapter.java | 5 ++-- .../dslv/SimpleDragSortCursorAdapter.java | 26 ++++++++++--------- 8 files changed, 30 insertions(+), 32 deletions(-) diff --git a/src/ch/blinkenlights/android/vanilla/FullPlaybackActivity.java b/src/ch/blinkenlights/android/vanilla/FullPlaybackActivity.java index 614c5ebe..9d795228 100644 --- a/src/ch/blinkenlights/android/vanilla/FullPlaybackActivity.java +++ b/src/ch/blinkenlights/android/vanilla/FullPlaybackActivity.java @@ -647,7 +647,7 @@ public class FullPlaybackActivity extends PlaybackActivity */ private static final int MSG_UPDATE_POSITION = 17; /** - * Calls {@link #seekToProgress()}. + * Calls {@link PlaybackService#seekToProgress(int)}. */ private static final int MSG_SEEK_TO_PROGRESS = 18; diff --git a/src/ch/blinkenlights/android/vanilla/NewPlaylistDialog.java b/src/ch/blinkenlights/android/vanilla/NewPlaylistDialog.java index 8d4c8340..40e4fb62 100644 --- a/src/ch/blinkenlights/android/vanilla/NewPlaylistDialog.java +++ b/src/ch/blinkenlights/android/vanilla/NewPlaylistDialog.java @@ -77,7 +77,6 @@ public class NewPlaylistDialog extends Dialog implements TextWatcher, View.OnCli * disabled when the EditText contains this text. * @param actionText A string resource describing the default positive * action (e.g. "Create"). - * @param intent An optional intent to store with the dialog. */ public NewPlaylistDialog(Context context, String initialText, int actionText, PlaylistTask playlistTask) { diff --git a/src/ch/blinkenlights/android/vanilla/Playlist.java b/src/ch/blinkenlights/android/vanilla/Playlist.java index 04f307d0..31398d54 100644 --- a/src/ch/blinkenlights/android/vanilla/Playlist.java +++ b/src/ch/blinkenlights/android/vanilla/Playlist.java @@ -200,7 +200,7 @@ public class Playlist { * Copy content from one playlist to another * * @param resolver A ContentResolver to use. - * @param sourceid The Media.Audio.Playlists id of the source playlist + * @param sourceId The Media.Audio.Playlists id of the source playlist * @param destinationId The Media.Audio.Playlists id of the destination playlist */ private static void _copyToPlaylist(ContentResolver resolver, long sourceId, long destinationId) { diff --git a/src/com/mobeta/android/dslv/DragSortController.java b/src/com/mobeta/android/dslv/DragSortController.java index 665889ea..c1ab6e7b 100644 --- a/src/com/mobeta/android/dslv/DragSortController.java +++ b/src/com/mobeta/android/dslv/DragSortController.java @@ -15,8 +15,8 @@ import android.widget.AdapterView; * creation. * * An instance of this class is meant to be passed to the methods - * {@link DragSortListView#setTouchListener()} and - * {@link DragSortListView#setFloatViewManager()} of your + * {@link DragSortListView#setOnTouchListener(View.OnTouchListener)} and + * {@link DragSortListView#setFloatViewManager(DragSortListView.FloatViewManager)} of your * {@link DragSortListView} instance. */ public class DragSortController extends SimpleFloatViewManager implements View.OnTouchListener, GestureDetector.OnGestureListener { @@ -82,7 +82,7 @@ public class DragSortController extends SimpleFloatViewManager implements View.O private int mPositionX; /** - * Calls {@link #DragSortController(DragSortListView, int)} with a + * Calls {@link #DragSortController(DragSortListView, int, int, int)} with a * 0 drag handle id, FLING_RIGHT_REMOVE remove mode, * and ON_DOWN drag init. By default, sorting is enabled, and * removal is disabled. @@ -130,7 +130,7 @@ public class DragSortController extends SimpleFloatViewManager implements View.O /** * Set how a drag is initiated. Needs to be one of - * {@link ON_DOWN}, {@link ON_DRAG}, or {@link ON_LONG_PRESS}. + * {@link #ON_DOWN}, {@link #ON_DRAG}, or {@link #ON_LONG_PRESS}. * * @param mode The drag init mode. */ @@ -154,9 +154,7 @@ public class DragSortController extends SimpleFloatViewManager implements View.O } /** - * One of {@link CLICK_REMOVE}, {@link FLING_RIGHT_REMOVE}, - * {@link FLING_LEFT_REMOVE}, - * {@link SLIDE_RIGHT_REMOVE}, or {@link SLIDE_LEFT_REMOVE}. + * One of {@link #CLICK_REMOVE}, {@link #FLING_REMOVE} */ public void setRemoveMode(int mode) { mRemoveMode = mode; diff --git a/src/com/mobeta/android/dslv/DragSortCursorAdapter.java b/src/com/mobeta/android/dslv/DragSortCursorAdapter.java index 52413bbc..b718d7c8 100644 --- a/src/com/mobeta/android/dslv/DragSortCursorAdapter.java +++ b/src/com/mobeta/android/dslv/DragSortCursorAdapter.java @@ -8,6 +8,7 @@ import android.util.SparseIntArray; import android.view.View; import android.view.ViewGroup; import android.widget.CursorAdapter; +import android.widget.ListAdapter; /** @@ -107,7 +108,7 @@ public abstract class DragSortCursorAdapter extends CursorAdapter implements Dra /** * On drop, this updates the mapping between Cursor positions * and ListView positions. The Cursor is unchanged. Retrieve - * the current mapping with {@link getCursorPositions()}. + * the current mapping with {@link #getCursorPositions()}. * * @see DragSortListView.DropListener#drop(int, int) */ @@ -135,7 +136,7 @@ public abstract class DragSortCursorAdapter extends CursorAdapter implements Dra /** * On remove, this updates the mapping between Cursor positions * and ListView positions. The Cursor is unchanged. Retrieve - * the current mapping with {@link getCursorPositions()}. + * the current mapping with {@link #getCursorPositions()}. * * @see DragSortListView.RemoveListener#remove(int) */ diff --git a/src/com/mobeta/android/dslv/DragSortListView.java b/src/com/mobeta/android/dslv/DragSortListView.java index c3ff125d..00c2a020 100644 --- a/src/com/mobeta/android/dslv/DragSortListView.java +++ b/src/com/mobeta/android/dslv/DragSortListView.java @@ -630,7 +630,7 @@ public class DragSortListView extends ListView { * a heavily wrapped ListAdapter (DragSortListView wraps the * input ListAdapter {\emph and} ListView wraps the wrapped one). * - * @return The ListAdapter set as the argument of {@link setAdapter()} + * @return The ListAdapter set as the argument of {@link #setAdapter(ListAdapter)} */ public ListAdapter getInputAdapter() { if (mAdapterWrapper == null) { @@ -903,8 +903,6 @@ public class DragSortListView extends ListView { * * @param position * @param top - * @param height Height of item at position. If -1, this function - * calculates this height. * * @return Shuffle line between position-1 and position (for * the given view of the list; that is, for when top of item at @@ -1468,7 +1466,7 @@ public class DragSortListView extends ListView { } /** - * Cancel a drag. Calls {@link #stopDrag(boolean, boolean)} with + * Cancel a drag. Calls {@link DragScroller#stopScrolling(boolean)} with * true as the first argument. */ public void cancelDrag() { @@ -2455,7 +2453,6 @@ public class DragSortListView extends ListView { * and the offset provided in {@link DragSortListView#startDrag}. * @param touch The current touch location (relative to DSLV * top-left). - * @param pendingScroll */ public void onDragFloatView(View floatView, Point location, Point touch); @@ -2482,7 +2479,7 @@ public class DragSortListView extends ListView { * Allows for easy toggling between a DragSortListView * and a regular old ListView. If enabled, items are * draggable, where the drag init mode determines how - * items are lifted (see {@link setDragInitMode(int)}). + * items are lifted (see {@link DragSortController#setDragInitMode(int)}). * If disabled, items cannot be dragged. * * @param enabled Set true to enable list diff --git a/src/com/mobeta/android/dslv/ResourceDragSortCursorAdapter.java b/src/com/mobeta/android/dslv/ResourceDragSortCursorAdapter.java index f2d08107..13baa7da 100644 --- a/src/com/mobeta/android/dslv/ResourceDragSortCursorAdapter.java +++ b/src/com/mobeta/android/dslv/ResourceDragSortCursorAdapter.java @@ -21,6 +21,7 @@ import android.database.Cursor; import android.view.View; import android.view.ViewGroup; import android.view.LayoutInflater; +import android.widget.CursorAdapter; // taken from v4 rev. 10 ResourceCursorAdapter.java @@ -61,7 +62,7 @@ public abstract class ResourceDragSortCursorAdapter extends DragSortCursorAdapte /** * Constructor with default behavior as per * {@link CursorAdapter#CursorAdapter(Context, Cursor, boolean)}; it is recommended - * you not use this, but instead {@link #ResourceCursorAdapter(Context, int, Cursor, int)}. + * you not use this, but instead {@link #ResourceDragSortCursorAdapter(Context, int, Cursor, int)}. * When using this constructor, {@link #FLAG_REGISTER_CONTENT_OBSERVER} * will always be set. * @@ -100,7 +101,7 @@ public abstract class ResourceDragSortCursorAdapter extends DragSortCursorAdapte /** * Inflates view(s) from the specified XML file. * - * @see android.widget.CursorAdapter#newView(android.content.Context, + * @see CursorAdapter#newView(android.content.Context, * android.database.Cursor, ViewGroup) */ @Override diff --git a/src/com/mobeta/android/dslv/SimpleDragSortCursorAdapter.java b/src/com/mobeta/android/dslv/SimpleDragSortCursorAdapter.java index 7a76ea9d..00505793 100644 --- a/src/com/mobeta/android/dslv/SimpleDragSortCursorAdapter.java +++ b/src/com/mobeta/android/dslv/SimpleDragSortCursorAdapter.java @@ -22,6 +22,8 @@ import android.net.Uri; import android.view.View; import android.widget.TextView; import android.widget.ImageView; +import android.widget.CursorAdapter; +import android.widget.SimpleCursorAdapter; // taken from sdk/sources/android-16/android/widget/SimpleCursorAdapter.java @@ -128,10 +130,10 @@ public class SimpleDragSortCursorAdapter extends ResourceDragSortCursorAdapter { * * @throws IllegalStateException if binding cannot occur * - * @see android.widget.CursorAdapter#bindView(android.view.View, + * @see CursorAdapter#bindView(android.view.View, * android.content.Context, android.database.Cursor) * @see #getViewBinder() - * @see #setViewBinder(android.widget.SimpleCursorAdapter.ViewBinder) + * @see #setViewBinder(ViewBinder) * @see #setViewImage(ImageView, String) * @see #setViewText(TextView, String) */ @@ -175,7 +177,7 @@ public class SimpleDragSortCursorAdapter extends ResourceDragSortCursorAdapter { * @return a ViewBinder or null if the binder does not exist * * @see #bindView(android.view.View, android.content.Context, android.database.Cursor) - * @see #setViewBinder(android.widget.SimpleCursorAdapter.ViewBinder) + * @see #setViewBinder(ViewBinder) */ public ViewBinder getViewBinder() { return mViewBinder; @@ -238,9 +240,9 @@ public class SimpleDragSortCursorAdapter extends ResourceDragSortCursorAdapter { * * @return a valid index in the current Cursor or -1 * - * @see android.widget.CursorAdapter#convertToString(android.database.Cursor) + * @see CursorAdapter#convertToString(android.database.Cursor) * @see #setStringConversionColumn(int) - * @see #setCursorToStringConverter(android.widget.SimpleCursorAdapter.CursorToStringConverter) + * @see #setCursorToStringConverter(CursorToStringConverter) * @see #getCursorToStringConverter() */ public int getStringConversionColumn() { @@ -256,9 +258,9 @@ public class SimpleDragSortCursorAdapter extends ResourceDragSortCursorAdapter { * @param stringConversionColumn a valid index in the current Cursor or -1 to use the default * conversion mechanism * - * @see android.widget.CursorAdapter#convertToString(android.database.Cursor) + * @see CursorAdapter#convertToString(android.database.Cursor) * @see #getStringConversionColumn() - * @see #setCursorToStringConverter(android.widget.SimpleCursorAdapter.CursorToStringConverter) + * @see #setCursorToStringConverter(CursorToStringConverter) * @see #getCursorToStringConverter() */ public void setStringConversionColumn(int stringConversionColumn) { @@ -272,10 +274,10 @@ public class SimpleDragSortCursorAdapter extends ResourceDragSortCursorAdapter { * @return null if the converter does not exist or an instance of * {@link android.widget.SimpleCursorAdapter.CursorToStringConverter} * - * @see #setCursorToStringConverter(android.widget.SimpleCursorAdapter.CursorToStringConverter) + * @see #setCursorToStringConverter(CursorToStringConverter) * @see #getStringConversionColumn() * @see #setStringConversionColumn(int) - * @see android.widget.CursorAdapter#convertToString(android.database.Cursor) + * @see CursorAdapter#convertToString(android.database.Cursor) */ public CursorToStringConverter getCursorToStringConverter() { return mCursorToStringConverter; @@ -288,10 +290,10 @@ public class SimpleDragSortCursorAdapter extends ResourceDragSortCursorAdapter { * @param cursorToStringConverter the Cursor to String converter, or * null to remove the converter * - * @see #setCursorToStringConverter(android.widget.SimpleCursorAdapter.CursorToStringConverter) + * @see #setCursorToStringConverter(CursorToStringConverter) * @see #getStringConversionColumn() * @see #setStringConversionColumn(int) - * @see android.widget.CursorAdapter#convertToString(android.database.Cursor) + * @see CursorAdapter#convertToString(android.database.Cursor) */ public void setCursorToStringConverter(CursorToStringConverter cursorToStringConverter) { mCursorToStringConverter = cursorToStringConverter; @@ -405,7 +407,7 @@ public class SimpleDragSortCursorAdapter extends ResourceDragSortCursorAdapter { * This class can be used by external clients of SimpleCursorAdapter * to define how the Cursor should be converted to a String. * - * @see android.widget.CursorAdapter#convertToString(android.database.Cursor) + * @see CursorAdapter#convertToString(android.database.Cursor) */ public static interface CursorToStringConverter { /**