Merge branch 'release-1.0.1'

markormesher · Mar 27, 2016 · d927357 · d927357
2 parents 02004ff + f63734f
commit d927357
Show file tree

Hide file tree

Showing 5 changed files with 9,229 additions and 10 deletions.
diff --git a/app/build.gradle b/app/build.gradle
@@ -13,8 +13,8 @@ buildscript {
 }
 
 def version = new Properties()
-version['code'] = 4
-version['name'] = '1.0.0'
+version['code'] = 5
+version['name'] = '1.0.1'
 
 def secrets = getSecrets()
 

diff --git a/fab/build.gradle b/fab/build.gradle
@@ -13,8 +13,8 @@ buildscript {
 }
 
 def version = new Properties()
-version['code'] = 4
-version['name'] = '1.0.0'
+version['code'] = 5
+version['name'] = '1.0.1'
 
 apply plugin: 'me.tatarka.retrolambda'
 
@@ -104,4 +104,4 @@ generateRelease.dependsOn(zipRelease)
 artifacts {
 	archives androidSourcesJar
 	archives androidJavadocsJar
-}
+}
diff --git a/fab/src/main/java/uk/co/markormesher/android_fab/FloatingActionButton.java b/fab/src/main/java/uk/co/markormesher/android_fab/FloatingActionButton.java
@@ -133,7 +133,7 @@ private void resetIcon() {
 	/**
 	 * Sets the colour of the FAB background.
 	 *
-	 * @param colour the colour of the FAB background
+	 * @param colour the colour of the FAB background, in aRGB format
 	 */
 	public void setBackgroundColour(int colour) {
 		cardView.setCardBackgroundColor(colour);
@@ -177,6 +177,7 @@ private void onClick() {
 	 * By setting an adapter, the speed-dial menu will be activated and the click listener will be removed.
 	 *
 	 * @param menuAdapter the menu adapter to use with this floating action button
+	 * @see uk.co.markormesher.android_fab.SpeedDialMenuAdapter
 	 */
 	public void setMenuAdapter(SpeedDialMenuAdapter menuAdapter) {
 		this.listener = null;

diff --git a/fab/src/main/java/uk/co/markormesher/android_fab/SpeedDialMenuAdapter.java b/fab/src/main/java/uk/co/markormesher/android_fab/SpeedDialMenuAdapter.java
@@ -16,16 +16,16 @@ public abstract class SpeedDialMenuAdapter {
 	/**
 	 * Returns the views that should be used for each item in the speed-dial menu.
 	 *
-	 * @param context  {@code Context} for the FAB, which can be used to create views
-	 * @param position the position to generate a view for, from 0 (furthest from the FAB) to {@code getCount()} - 1, inclusive
-	 * @return a {@code MenuItemViews} wrapper containing the icon and (optionally) the label for the menu item
+	 * @param context  {@code android.content.Context} for the FAB, which can be used to create views
+	 * @param position the position to generate a view for, from 0 (furthest from the FAB) to {@code getCount() - 1} (closest), inclusive
+	 * @return an array of exactly two views
 	 */
 	protected abstract MenuItem getViews(Context context, int position);
 
 	/**
 	 * Returns the background colour to set for the menu item's "disc".
 	 *
-	 * @param position the position to generate a view for, from 0 (furthest from the FAB) to {@code getCount()} - 1, inclusive
+	 * @param position the position to set the colour for, from 0 (furthest from the FAB) to {@code getCount() - 1} (closest), inclusive
 	 * @return the colour to set
 	 */
 	protected int getBackgroundColour(int position) {