From 952e05214242d5e23ae898cf3803a87308c63be8 Mon Sep 17 00:00:00 2001 From: Ian Jackson Date: Wed, 25 Aug 2010 00:33:05 +0100 Subject: [PATCH] fix up comments for the way things are now, and update the licence file --- LICENCE | 12 ++++-- README | 3 ++ .../tedpearson/ypp/market/ControlPanel.java | 2 +- .../tedpearson/ypp/market/MarketUploader.java | 39 +++++++------------ 4 files changed, 27 insertions(+), 29 deletions(-) diff --git a/LICENCE b/LICENCE index 9ee4d5f..fc4b4ab 100644 --- a/LICENCE +++ b/LICENCE @@ -1,11 +1,15 @@ jpctb is Free Software. -The Linux wrapper script is copyright (C) 2009 Ian Jackson +The Linux "jpctb" wrapper script is: + Copyright (C) 2009-2010 Ian Jackson -com.tedpearson.* Java source code is copyright (C) 2009 Ted Pearson -and Owen Dunn +com.tedpearson.* Java source code is: + Copyright (C) 2009 Ted Pearson and Owen Dunn + Copyright (C) 2010 Owen Dunn and Ian Jackson -All other components are copyright (C) 2009 Owen Dunn. +All other components are: + Copyright (C) 2009 Owen Dunn + Copyright (C) 2010 Owen Dunn and Ian Jackson All of the above are distributed under the terms of the following licence: diff --git a/README b/README index c588d98..eca9ddc 100644 --- a/README +++ b/README @@ -1,6 +1,9 @@ JPCTB - a client for uploading to Yarrg and PCTB ================================================ +See the YARRG website for more information: + http://yarrg.chiark.net/upload + Linux ----- diff --git a/src/com/tedpearson/ypp/market/ControlPanel.java b/src/com/tedpearson/ypp/market/ControlPanel.java index b42232f..dc91b06 100644 --- a/src/com/tedpearson/ypp/market/ControlPanel.java +++ b/src/com/tedpearson/ypp/market/ControlPanel.java @@ -7,7 +7,7 @@ import java.util.prefs.*; /** * ControlPanel is a simple management utility that sets -* a preference for whether the PCTB client is to launch or not. +* a preference for which server(s) to upload to. */ public class ControlPanel extends JFrame { public static void main(String[] args) { diff --git a/src/com/tedpearson/ypp/market/MarketUploader.java b/src/com/tedpearson/ypp/market/MarketUploader.java index 306c7d7..6a355ff 100644 --- 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}. -*

-* 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) { -- 2.30.2