Skip to content
This repository has been archived by the owner on Aug 8, 2023. It is now read-only.

Commit

Permalink
[android] fix javadoc minor mistakes and typos
Browse files Browse the repository at this point in the history
  • Loading branch information
Guardiola31337 authored and tobrun committed Jun 20, 2017
1 parent b2f7638 commit 6d52bcf
Show file tree
Hide file tree
Showing 9 changed files with 15 additions and 17 deletions.
Original file line number Diff line number Diff line change
Expand Up @@ -91,7 +91,7 @@ public Icon fromBitmap(@NonNull Bitmap bitmap) {
}

/**
* Create an icon using the resource ID of a Bitmap image.
* Creates an icon using the resource ID of a Bitmap image.
*
* @param resourceId The resource ID of a Bitmap image.
* @return The icon that was loaded from the asset or {@code null} if failed to load.
Expand Down Expand Up @@ -155,8 +155,7 @@ public Icon fromAsset(@NonNull String assetName) {
* Creates an Icon using the absolute file path of a Bitmap image.
*
* @param absolutePath The absolute path of the Bitmap image.
* @return The Icon that was loaded from the absolute path or null if failed to
* load.
* @return The Icon that was loaded from the absolute path or null if failed to load.
*/
public Icon fromPath(@NonNull String absolutePath) {
Bitmap bitmap = BitmapFactory.decodeFile(absolutePath, options);
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -6,8 +6,8 @@

/**
* <p>
* A IconBitmapChangedException is thrown by MapView when a Marker is added
* that has a Icon with a Bitmap that has been modified since the creation of the Icon.
* An IconBitmapChangedException is thrown by MapView when a Marker is added
* that has an Icon with a Bitmap that has been modified since the creation of the Icon.
* </p>
* You cannot modify a {@code Icon} after it has been added to the map in a {@code Marker}
*
Expand Down
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
package com.mapbox.mapboxsdk.exceptions;

/**
* A InvalidLatLngBoundsException is thrown by LatLngBounds
* An InvalidLatLngBoundsException is thrown by LatLngBounds
* when there aren't enough LatLng to create a bounds.
*/
public class InvalidLatLngBoundsException extends RuntimeException {
Expand Down
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
package com.mapbox.mapboxsdk.geometry;

/**
* Describes a latitude, longitude and altitude pair.
* Describes a latitude, longitude and altitude tuple.
*/
public interface ILatLng {

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -92,7 +92,7 @@ public LatLng(LatLng latLng) {
}

/**
* Constructs a new latitude, longitude, altitude pair given a parcel.
* Constructs a new latitude, longitude, altitude tuple given a parcel.
*
* @param in the parcel containing the latitude, longitude, altitude values
*/
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -53,8 +53,7 @@ public ProjectedMeters(ProjectedMeters projectedMeters) {
/**
* Creates a ProjectedMeters from a Parcel.
*
* @param in The parcel to create from /**
* Describe the kinds of special objects contained in this Parcelable instance's marshaled representation.
* @param in The parcel to create from
* @return a bitmask indicating the set of special object types marshaled by this Parcelable object instance.
*/
private ProjectedMeters(Parcel in) {
Expand Down Expand Up @@ -122,7 +121,7 @@ public int hashCode() {
/**
* Returns a string representation of the object.
*
* @return the string represnetation of this
* @return the string representation of this
*/
@Override
public String toString() {
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -38,7 +38,7 @@ public class VisibleRegion implements Parcelable {
public final LatLngBounds latLngBounds;

/**
* Creates a VisibleRegion form a Parcel.
* Creates a VisibleRegion from a Parcel.
*
* @param in The Parcel to create this from
*/
Expand Down Expand Up @@ -96,7 +96,7 @@ public boolean equals(Object o) {
/**
* The string representation of the object.
*
* @return the string representatio of this
* @return the string representation of this
*/
@Override
public String toString() {
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -736,8 +736,8 @@ public final void easeCamera(CameraUpdate update, int durationMs, boolean easing
* will return the current location of the camera in flight.
* <p>
* Note that this will cancel location tracking mode if enabled. You can change this behaviour by calling
* {@link com.mapbox.mapboxsdk.maps.TrackingSettings#setDismissLocationTrackingOnGesture(boolean)} and with false
* before invoking this method and calling it with true in the {@link CancelableCallback#onFinish()}.
* {@link com.mapbox.mapboxsdk.maps.TrackingSettings#setDismissLocationTrackingOnGesture(boolean)} with false before
* invoking this method and calling it with true in the {@link CancelableCallback#onFinish()}.
* </p>
*
* @param update The change that should be applied to the camera.
Expand Down Expand Up @@ -1081,7 +1081,7 @@ public void setStyle(@Style.StyleUrl String style) {
* sent.
*
* @param style The bundled style.
* @param callback The calback to be invoked when the ha finished loading
* @param callback The callback to be invoked when the style has finished loading
* @see Style
*/
@UiThread
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -104,7 +104,7 @@ public int getDownloadState() {
* Get the number of resources (inclusive of tiles) that have been fully downloaded
* and are ready for offline access.
*
* @return the amount of resurces that have finished downloading.
* @return the amount of resources that have finished downloading.
*/
public long getCompletedResourceCount() {
return completedResourceCount;
Expand Down

0 comments on commit 6d52bcf

Please sign in to comment.