diff options
| author | Samuel Tardieu <sam@rfc1149.net> | 2013-01-26 22:58:20 +0100 |
|---|---|---|
| committer | Samuel Tardieu <sam@rfc1149.net> | 2013-01-26 22:58:20 +0100 |
| commit | 2f541d3b40e67e03c540f4e10dccf0384854fd0e (patch) | |
| tree | 2d9486a7d11ffde7ebbb08ea05aa2886169bcb67 | |
| parent | 39b49aadcad15902f31b188d2b0630e35b0702c2 (diff) | |
| download | cgeo-2f541d3b40e67e03c540f4e10dccf0384854fd0e.zip cgeo-2f541d3b40e67e03c540f4e10dccf0384854fd0e.tar.gz cgeo-2f541d3b40e67e03c540f4e10dccf0384854fd0e.tar.bz2 | |
Add documentation of what is an unset waypoint id
| -rw-r--r-- | main/src/cgeo/geocaching/IWaypoint.java | 8 |
1 files changed, 5 insertions, 3 deletions
diff --git a/main/src/cgeo/geocaching/IWaypoint.java b/main/src/cgeo/geocaching/IWaypoint.java index 78e3b43..2b992e1 100644 --- a/main/src/cgeo/geocaching/IWaypoint.java +++ b/main/src/cgeo/geocaching/IWaypoint.java @@ -1,12 +1,14 @@ -/** - * - */ package cgeo.geocaching; import cgeo.geocaching.enumerations.WaypointType; public interface IWaypoint extends ILogable, ICoordinates { + /** + * Return an unique waypoint id. + * + * @return a non-negative id if set, -1 if unset + */ public abstract int getId(); public abstract WaypointType getWaypointType(); |