[gnome-maps/wip/fix-geoloc: 5/8] Add documentation
- From: Mattias Bengtsson <mattiasb src gnome org>
- To: commits-list gnome org
- Cc:
- Subject: [gnome-maps/wip/fix-geoloc: 5/8] Add documentation
- Date: Thu, 11 Jul 2013 02:22:44 +0000 (UTC)
commit 3eb15992c37143349e75f2b8aebaea25a0a5562d
Author: Mattias Bengtsson <mattias jc bengtsson gmail com>
Date: Wed Jul 10 19:16:07 2013 +0200
Add documentation
Document a few functions here and there.
src/mapLocation.js | 8 ++++++++
1 files changed, 8 insertions(+), 0 deletions(-)
---
diff --git a/src/mapLocation.js b/src/mapLocation.js
index 6e277a3..989d537 100644
--- a/src/mapLocation.js
+++ b/src/mapLocation.js
@@ -32,6 +32,9 @@ const Utils = imports.utils;
const Path = imports.path;
const _ = imports.gettext.gettext;
+/**
+ * A map location object with an added accuracy.
+ */
const MapLocation = new Lang.Class({
Name: 'MapLocation',
@@ -44,6 +47,11 @@ const MapLocation = new Lang.Class({
this.accuracy = geocodeLocation.accuracy;
},
+ /**
+ * Go to this location from the current location on the map, optionally
+ * with an animation
+ */
+ // TODO: break this out somewhere, this is useful in other cases as well.
goTo: function(animate) {
log("Going to " + this.description);
[
Date Prev][
Date Next] [
Thread Prev][
Thread Next]
[
Thread Index]
[
Date Index]
[
Author Index]