Added documentation

This commit is contained in:
Lennart Hensler committed 2012-01-11 16:14:25 +01:00
1 parent c752bd0020
commit 38669a725f
1 file changed
+19 -2
@@ -22,13 +22,30 @@ public interface Placemark {
*/
String getCountryCode();
/**
* @return The {@link Position} of the Placemark
* @return The {@link Position} of the Placemark
*/
Position getPosition();
/**
* @return The population of the Placemark
*/
long getPopulation();
Distance distanceFrom(Position p);
/**
* @param position The {@link Position} from which the distance is calculated
* @return The {@link Distance} between the given {@link Position} and the Placemark
*/
Distance distanceFrom(Position position);
/**
* Creates a new {@link Position} out of the given coordinates and calculates the distance between {@link Position} and
* the Placemark via {@link Placemark#distanceFrom(Position) distanceFrom(Position)}.
* @param latDeg Latitude in degrees
* @param lngDeg Longitude in degrees
* @return The {@link Distance} between the given coordinates and the Placemark
*/
Distance distanceFrom(double latDeg, double lngDeg);
/**
* @return The name of the country where the Placemark is located
*/
String getCountryName();