formatting

This commit is contained in:
Hannes Janetzek
2013-02-04 20:14:58 +01:00
parent 303e0cb4ce
commit f2b7a9fdf8
72 changed files with 403 additions and 240 deletions

View File

@@ -100,6 +100,7 @@ public abstract class MapActivity extends Activity {
/**
* This method is called once by each MapView during its setup process.
*
* @param mapView
* the calling MapView.
*/

View File

@@ -27,7 +27,8 @@ import android.graphics.Paint;
import android.graphics.Typeface;
/**
* A MapScaleBar displays the ratio of a distance on the map to the corresponding distance on the ground.
* A MapScaleBar displays the ratio of a distance on the map to the
* corresponding distance on the ground.
*/
public class MapScaleBar {
/**
@@ -128,7 +129,8 @@ public class MapScaleBar {
/**
* @param imperialUnits
* true if imperial units should be used rather than metric units.
* true if imperial units should be used rather than metric
* units.
*/
public void setImperialUnits(boolean imperialUnits) {
mImperialUnits = imperialUnits;
@@ -145,7 +147,7 @@ public class MapScaleBar {
/**
* Overrides the specified text field with the given string.
*
*
* @param textField
* the text field to override.
* @param value
@@ -188,7 +190,7 @@ public class MapScaleBar {
/**
* Redraws the map scale bitmap with the given parameters.
*
*
* @param scaleBarLength
* the length of the map scale bar in pixels.
* @param mapScaleValue

View File

@@ -273,6 +273,7 @@ public class MapView extends RelativeLayout {
/**
* Calculates all necessary tiles and adds jobs accordingly.
*
* @param changedPos TODO
*/
public void redrawMap(boolean changedPos) {
@@ -344,6 +345,7 @@ public class MapView extends RelativeLayout {
/**
* Sets the MapDatabase for this MapView.
*
* @param options
* the new MapDatabase options.
* @return ...
@@ -395,6 +397,7 @@ public class MapView extends RelativeLayout {
/**
* Sets the internal theme which is used for rendering the map.
*
* @param internalRenderTheme
* the internal rendering theme.
* @return ...
@@ -419,6 +422,7 @@ public class MapView extends RelativeLayout {
/**
* Sets the theme file which is used for rendering the map.
*
* @param renderThemePath
* the path to the XML file which defines the rendering theme.
* @throws IllegalArgumentException
@@ -572,6 +576,7 @@ public class MapView extends RelativeLayout {
/**
* Sets the center and zoom level of this MapView and triggers a redraw.
*
* @param mapPosition
* the new map position of this MapView.
*/
@@ -585,6 +590,7 @@ public class MapView extends RelativeLayout {
/**
* Sets the center of the MapView and triggers a redraw.
*
* @param geoPoint
* the new center point of the map.
*/
@@ -604,6 +610,7 @@ public class MapView extends RelativeLayout {
/**
* add jobs and remember MapWorkers that stuff needs to be done
*
* @param jobs
* tile jobs
*/
@@ -644,6 +651,7 @@ public class MapView extends RelativeLayout {
* You can add/remove/reorder your Overlays using the List of
* {@link Overlay}. The first (index 0) Overlay gets drawn first, the one
* with the highest as the last one.
*
* @return ...
*/
public List<Overlay> getOverlays() {

View File

@@ -164,12 +164,12 @@ public class MapViewPosition {
// get the z-value of the map-plane for a point on screen
private float getZ(float y) {
// calculate the intersection of a ray from
// calculate the intersection of a ray from
// camera origin and the map plane
// origin is moved by VIEW_DISTANCE
double cx = VIEW_DISTANCE;
// 'height' of the ray
// 'height' of the ray
double ry = y * (mHeight / mWidth) * 0.5f;
// tilt of the plane (center is kept on x = 0)
@@ -247,6 +247,7 @@ public class MapViewPosition {
/**
* ...
*
* @return BoundingBox containing view
*/
public synchronized BoundingBox getViewBox() {
@@ -298,6 +299,7 @@ public class MapViewPosition {
/**
* for x,y in screen coordinates get the point on the map in map-tile
* coordinates
*
* @param x ...
* @param y ...
* @param reuse ...
@@ -320,6 +322,7 @@ public class MapViewPosition {
/**
* get the GeoPoint for x,y in screen coordinates
*
* @param x screen pixel x
* @param y screen pixel y
* @return the corresponding GeoPoint
@@ -344,6 +347,7 @@ public class MapViewPosition {
/**
* get the screen pixel for a GeoPoint
*
* @param geoPoint ...
* @param reuse ...
* @return ...
@@ -456,6 +460,7 @@ public class MapViewPosition {
/**
* Moves this MapViewPosition by the given amount of pixels.
*
* @param mx the amount of pixels to move the map horizontally.
* @param my the amount of pixels to move the map vertically.
*/
@@ -492,6 +497,7 @@ public class MapViewPosition {
/**
* -
*
* @param scale ...
* @param pivotX ...
* @param pivotY ...
@@ -537,6 +543,7 @@ public class MapViewPosition {
/**
* rotate map around pivot cx,cy
*
* @param angle ...
* @param cx ...
* @param cy ...

View File

@@ -139,7 +139,7 @@ public class MapZoomControls {
/**
* Zooms in or out by the given amount of zoom levels.
*
*
* @param zoomLevelDiff
* the difference to the current zoom level.
* @return true if the zoom level was changed, false otherwise.
@@ -208,7 +208,7 @@ public class MapZoomControls {
* are {@link Gravity#TOP}, {@link Gravity#CENTER_VERTICAL},
* {@link Gravity#BOTTOM}, {@link Gravity#LEFT},
* {@link Gravity#CENTER_HORIZONTAL} and {@link Gravity#RIGHT}.
*
*
* @param zoomControlsGravity
* a combination of {@link Gravity} constants describing the
* desired placement.
@@ -227,7 +227,7 @@ public class MapZoomControls {
* current {@link TileGenerator}. For example, downloading map tiles may
* only be possible up to a certain zoom level. Setting a higher maximum
* zoom level has no effect in this case.
*
*
* @param zoomLevelMax
* the maximum zoom level.
* @throws IllegalArgumentException
@@ -243,7 +243,7 @@ public class MapZoomControls {
/**
* Sets the minimum zoom level of the map.
*
*
* @param zoomLevelMin
* the minimum zoom level.
* @throws IllegalArgumentException