fix up comments for the way things are now, and update the licence file

[jarrg-ian.git] / src / com / tedpearson / ypp / market / MarketUploader.java

diff --git a/src/com/tedpearson/ypp/market/MarketUploader.java b/src/com/tedpearson/ypp/market/MarketUploader.java
index 306c7d72c13869ccb4dce3badae2971577078de7..6a355ff94abafe439b55c2406138b51b4241dfda 100644 (file)
--- a/src/com/tedpearson/ypp/market/MarketUploader.java
+++ b/src/com/tedpearson/ypp/market/MarketUploader.java
@@ -22,26 +22,18 @@ import java.util.prefs.Preferences;
 import java.beans.*;
 import com.tedpearson.util.update.*;
 
-/*
-       TODO:
-       allow adding new islands
-       allow adding new oceans
-*/
-
 /**
-*      MarketUploader is a class that handles the uploading of market data from
-*      Yohoho! Puzzle Pirates. Currently, it must be launched in the save Java
-*      Virtual Machine as YPP. This is handled by a sister "helper" class,
-*      {@link MarketUploaderRunner}.
-*      <p>
-*      MarketUploader initializes after the main YPP window has initialized. It
-*      provides a simple window with a "Capture Market Data" button displayed.
-*      Upon clicking this button, a progress dialog is displayed, and the data
-*      is processed and submitted to the Pirate Commodities Trader with Bleach (PCTB)
-*      web server. If any errors occur, an error dialog is shown, and processing
-*      returns, the button becoming re-enabled.
-*      
-*      @see MarketUploaderRunner
+*      MarketUploader is a class that handles the uploading of market
+*      data from Yohoho! Puzzle Pirates via the Java Accessibility
+*      API.
+*
+*      MarketUploader initializes after the main YPP window has
+*      initialized. It provides a simple window with a "Capture
+*      Market Data" button displayed.  Upon clicking this button, a
+*      progress dialog is displayed, and the data is processed and
+*      submitted to the YARRG and PCTB servers. If any errors occur,
+*      an error dialog is shown, and processing returns, the button
+*      becoming re-enabled.
 */
 public class MarketUploader implements TopLevelWindowListener, GUIInitializedListener {
        private JFrame frame = null;
@@ -223,9 +215,7 @@ public class MarketUploader implements TopLevelWindowListener, GUIInitializedLis
        }
        
        /**
-       *       Entry point. Remove modified files and replace with backups.
-       *       Register the jar file we are running from to be deleted upon quit.
-       *       Finally, conditionally set up the GUI.
+       *       Entry point.  Read our preferences.
        */
        public MarketUploader() {
                // check if we've been turned off in the control panel
@@ -255,8 +245,9 @@ public class MarketUploader implements TopLevelWindowListener, GUIInitializedLis
        }
        
        /**
-       *       Set up the GUI, with its window and one-button interface. Only initialize
-       *       if we're running alongside a Window named "Puzzle Pirates" though.
+       *       Set up the GUI, with its window and one-button
+       *       interface. Only initialize if we're running alongside
+       *       a Window named "Puzzle Pirates" though.
        */
        private void createGUI() {
                if (frame != null && window != null) {