norohind/vanilla
1
0
Fork 0
Code Issues 1 Pull Requests Projects Releases Wiki Activity

Doc fixes

Browse Source
This commit is contained in:
Christopher Eby 2012-03-01 00:47:00 -06:00
parent 2699be1cdb
commit 88fe955b23
3 changed files with 9 additions and 11 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

14
src/org/kreed/vanilla/LibraryActivity.java
View File

@ -358,7 +358,7 @@ public class LibraryActivity
* Adds songs matching the data from the given intent to the song timelime. * Adds songs matching the data from the given intent to the song timelime.
* *
* @param intent An intent created with * @param intent An intent created with
* {@link LibraryActivity#createClickIntent(LibraryAdapter,MediaView)}. * {@link LibraryAdapter#createData(View)}.
* @param action One of LibraryActivity.ACTION_* * @param action One of LibraryActivity.ACTION_*
*/ */
private void pickSongs(Intent intent, int action) private void pickSongs(Intent intent, int action)
@ -396,7 +396,7 @@ public class LibraryActivity
* from the view and switching to the appropriate tab. * from the view and switching to the appropriate tab.
* *
* @param intent An intent created with * @param intent An intent created with
* {@link LibraryActivity#createClickIntent(LibraryAdapter,MediaView)}. * {@link LibraryAdapter#createData(View)}.
*/ */
private void expand(Intent intent) private void expand(Intent intent)
{ {
@ -421,7 +421,7 @@ public class LibraryActivity
/** /**
* Called by LibraryAdapters when a row has been clicked. * Called by LibraryAdapters when a row has been clicked.
* *
* @param row The data for the row that was clicked. * @param rowData The data for the row that was clicked.
*/ */
public void onItemClicked(Intent rowData) public void onItemClicked(Intent rowData)
{ {
@ -446,7 +446,7 @@ public class LibraryActivity
/** /**
* Called by LibraryAdapters when a row's expand arrow has been clicked. * Called by LibraryAdapters when a row's expand arrow has been clicked.
* *
* @param row The data for the row that was clicked. * @param rowData The data for the row that was clicked.
*/ */
public void onItemExpanded(Intent rowData) public void onItemExpanded(Intent rowData)
{ {
@ -563,7 +563,7 @@ public class LibraryActivity
* Builds a media query based off the data stored in the given intent. * Builds a media query based off the data stored in the given intent.
* *
* @param intent An intent created with * @param intent An intent created with
* {@link LibraryActivity#createClickIntent(LibraryAdapter,MediaView)}. * {@link LibraryAdapter#createData(View)}.
* @param empty If true, use the empty projection (only query id). * @param empty If true, use the empty projection (only query id).
* @param all If true query all songs in the adapter; otherwise query based * @param all If true query all songs in the adapter; otherwise query based
* on the row selected. * on the row selected.
@ -644,7 +644,7 @@ public class LibraryActivity
* *
* @param playlistId The id of the playlist to add to. * @param playlistId The id of the playlist to add to.
* @param intent An intent created with * @param intent An intent created with
* {@link LibraryActivity#createClickIntent(LibraryAdapter,MediaView)}. * {@link LibraryAdapter#createData(View)}.
*/ */
private void addToPlaylist(long playlistId, Intent intent) private void addToPlaylist(long playlistId, Intent intent)
{ {
@ -671,7 +671,7 @@ public class LibraryActivity
* informing the user of this. * informing the user of this.
* *
* @param intent An intent created with * @param intent An intent created with
* {@link LibraryActivity#createClickIntent(LibraryAdapter,MediaView)}. * {@link LibraryAdapter#createData(View)}.
*/ */
private void delete(Intent intent) private void delete(Intent intent)
{ {

4
src/org/kreed/vanilla/LibraryAdapter.java
View File

@ -127,11 +127,11 @@ public interface LibraryAdapter extends ListAdapter {
public static final String DATA_TYPE = "type"; public static final String DATA_TYPE = "type";
/** /**
* Extra for row data: canonical file path. type: String. Only present if * Extra for row data: canonical file path. type: String. Only present if
* type is {@link MediaUtils.TYPE_FILE}. * type is {@link MediaUtils#TYPE_FILE}.
*/ */
public static final String DATA_FILE = "file"; public static final String DATA_FILE = "file";
/** /**
* Extra for row data: if true, row has expander arrow. type: boolean. * Extra for row data: if true, row has expander arrow. type: boolean.
*/ */
public static final String DATA_EXPANDABLE = "expandable"; public static final String DATA_EXPANDABLE = "expandable";
} }

2
src/org/kreed/vanilla/MediaAdapter.java
View File

@ -144,8 +144,6 @@ public class MediaAdapter
* @param type The type of media to represent. Must be one of the * @param type The type of media to represent. Must be one of the
* Song.TYPE_* constants. This determines which content provider to query * Song.TYPE_* constants. This determines which content provider to query
* and what fields to display in the views. * and what fields to display in the views.
* @param expandable Whether an expand arrow should be shown to the right
* of the views' text
* @param limiter An initial limiter to use * @param limiter An initial limiter to use
*/ */
public MediaAdapter(LibraryActivity activity, int type, Limiter limiter) public MediaAdapter(LibraryActivity activity, int type, Limiter limiter)