Merge branch 'master' of github.com:systemed/potlatch2
[potlatch2.git] / net / systemeD / potlatch2 / utils / SnapshotConnection.as
index 96322c2f2e0c81a14cb81c7fa8b3865256becd4d..a374a0651c74fd993b554166f4256443e69c2063 100644 (file)
@@ -4,6 +4,13 @@ package net.systemeD.potlatch2.utils {
     import flash.events.Event;
     import flash.net.*;
 
+    /**
+    * A connection to a Snapshot server. A Snapshot server serves OSM map requests and can also
+    * track the "status" of an entity. Most other types of XMLConnection requests will fail. See
+    * http://www.github.com/gravitystorm/snapshot-server for example code based on the database
+    * structure created by osmosis pgsnapshot schema.
+    */
+
     public class SnapshotConnection extends XMLConnection {
 
         public function SnapshotConnection(cname:String,api:String,policy:String,initparams:Object=null) {
@@ -13,7 +20,9 @@ package net.systemeD.potlatch2.utils {
 
         // As it stands, the following two functions could be refactored further.
 
-        /** Post a status update call to the server and update entity.status if successful */
+        /**
+        * Post a status update call to the server and update entity.status if successful.
+        */
         public function markComplete(entity:Entity):void {
             var urlReq:URLRequest;
 
@@ -31,7 +40,9 @@ package net.systemeD.potlatch2.utils {
             }
         }
 
-        /** Send a "complete" call to the server and update entity.status if successful */
+        /**
+        * Send a "complete" call to the server and update entity.status if successful.
+        */
         public function markNotComplete(entity:Entity):void {
             var urlReq:URLRequest;