[gnome-maps/wip/fix-geoloc: 6/11] Add documentation

[Mattias Bengtsson <mattiasb src gnome org>]

commit 375b1bfc45f082100d3cd2562b0d99fda798b073
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 4d3aa48..d5d5e46 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);