From 0c2456c7188384071d932eb1d991edfab290dd78 Mon Sep 17 00:00:00 2001 From: Doublestrike Date: Sat, 14 Apr 2012 08:43:55 +0000 Subject: [PATCH] Javadoc updates. --- .../gui/home/quest/CSubmenuChallenges.java | 4 +- .../forge/gui/home/quest/CSubmenuDuels.java | 4 +- .../gui/home/quest/CSubmenuQuestData.java | 4 +- .../gui/home/quest/CSubmenuQuestDecks.java | 4 +- .../gui/home/quest/CSubmenuQuestPrefs.java | 4 +- .../gui/home/quest/VSubmenuChallenges.java | 6 ++- .../forge/gui/home/quest/VSubmenuDuels.java | 6 ++- .../gui/home/quest/VSubmenuQuestData.java | 42 ++++++++++++------- .../gui/home/quest/VSubmenuQuestDecks.java | 4 +- .../gui/home/quest/VSubmenuQuestPrefs.java | 4 +- .../home/sanctioned/CSubmenuConstructed.java | 4 +- .../gui/home/sanctioned/CSubmenuDraft.java | 5 ++- .../gui/home/sanctioned/CSubmenuSealed.java | 8 +++- .../home/sanctioned/VSubmenuConstructed.java | 4 +- .../gui/home/sanctioned/VSubmenuDraft.java | 4 +- .../gui/home/sanctioned/VSubmenuSealed.java | 4 +- .../gui/home/settings/CSubmenuAvatars.java | 4 +- .../home/settings/CSubmenuPreferences.java | 4 +- .../gui/home/settings/VSubmenuAvatars.java | 4 +- .../home/settings/VSubmenuPreferences.java | 4 +- .../home/utilities/CSubmenuDeckEditor.java | 4 +- .../gui/home/utilities/CSubmenuExit.java | 4 +- .../gui/home/utilities/CSubmenuUtilities.java | 4 +- .../home/utilities/VSubmenuDeckEditor.java | 4 +- .../gui/home/utilities/VSubmenuExit.java | 4 +- .../gui/home/utilities/VSubmenuUtilities.java | 4 +- 26 files changed, 111 insertions(+), 40 deletions(-) diff --git a/src/main/java/forge/gui/home/quest/CSubmenuChallenges.java b/src/main/java/forge/gui/home/quest/CSubmenuChallenges.java index cc3129c122d..d6998d03836 100644 --- a/src/main/java/forge/gui/home/quest/CSubmenuChallenges.java +++ b/src/main/java/forge/gui/home/quest/CSubmenuChallenges.java @@ -21,7 +21,9 @@ import forge.quest.bazaar.QuestItemType; import forge.quest.bazaar.QuestPetController; /** - * TODO: Write javadoc for this type. + * Controls the quest challenges submenu in the home UI. + * + *

(C at beginning of class name denotes a control class.) * */ public enum CSubmenuChallenges implements ICSubmenu { diff --git a/src/main/java/forge/gui/home/quest/CSubmenuDuels.java b/src/main/java/forge/gui/home/quest/CSubmenuDuels.java index afea7af5c68..e4d0e083ab4 100644 --- a/src/main/java/forge/gui/home/quest/CSubmenuDuels.java +++ b/src/main/java/forge/gui/home/quest/CSubmenuDuels.java @@ -15,7 +15,9 @@ import forge.quest.QuestEventDuel; import forge.quest.bazaar.QuestPetController; /** - * TODO: Write javadoc for this type. + * Controls the quest duels submenu in the home UI. + * + *

(C at beginning of class name denotes a control class.) * */ public enum CSubmenuDuels implements ICSubmenu { diff --git a/src/main/java/forge/gui/home/quest/CSubmenuQuestData.java b/src/main/java/forge/gui/home/quest/CSubmenuQuestData.java index 146003c54f0..78cf30dfbea 100644 --- a/src/main/java/forge/gui/home/quest/CSubmenuQuestData.java +++ b/src/main/java/forge/gui/home/quest/CSubmenuQuestData.java @@ -27,7 +27,9 @@ import forge.quest.data.QuestPreferences.QPref; import forge.quest.io.QuestDataIO; /** - * TODO: Write javadoc for this type. + * Controls the quest data submenu in the home UI. + * + *

(C at beginning of class name denotes a control class.) * */ @SuppressWarnings("serial") diff --git a/src/main/java/forge/gui/home/quest/CSubmenuQuestDecks.java b/src/main/java/forge/gui/home/quest/CSubmenuQuestDecks.java index ddfb0981573..4b456fbf7fe 100644 --- a/src/main/java/forge/gui/home/quest/CSubmenuQuestDecks.java +++ b/src/main/java/forge/gui/home/quest/CSubmenuQuestDecks.java @@ -15,7 +15,9 @@ import forge.quest.QuestController; import forge.quest.data.QuestPreferences.QPref; /** - * TODO: Write javadoc for this type. + * Controls the quest decks submenu in the home UI. + * + *

(C at beginning of class name denotes a control class.) */ @SuppressWarnings("serial") public enum CSubmenuQuestDecks implements ICSubmenu { diff --git a/src/main/java/forge/gui/home/quest/CSubmenuQuestPrefs.java b/src/main/java/forge/gui/home/quest/CSubmenuQuestPrefs.java index 6381d2f8428..3d16cafe506 100644 --- a/src/main/java/forge/gui/home/quest/CSubmenuQuestPrefs.java +++ b/src/main/java/forge/gui/home/quest/CSubmenuQuestPrefs.java @@ -8,7 +8,9 @@ import forge.quest.data.QuestPreferences; import forge.quest.data.QuestPreferences.QPref; /** - * TODO: Write javadoc for this type. + * Controls the quest preferences submenu in the home UI. + * + *

(C at beginning of class name denotes a control class.) * */ public enum CSubmenuQuestPrefs implements ICSubmenu { diff --git a/src/main/java/forge/gui/home/quest/VSubmenuChallenges.java b/src/main/java/forge/gui/home/quest/VSubmenuChallenges.java index 2b976002f59..51088dbbec5 100644 --- a/src/main/java/forge/gui/home/quest/VSubmenuChallenges.java +++ b/src/main/java/forge/gui/home/quest/VSubmenuChallenges.java @@ -22,7 +22,11 @@ import forge.gui.toolbox.FPanel; import forge.gui.toolbox.FScrollPane; import forge.gui.toolbox.FSkin; -/** */ +/** + * Assembles Swing components of quest challenges submenu singleton. + * + *

(V at beginning of class name denotes a view class.) + */ public enum VSubmenuChallenges implements IVSubmenu, IStatsAndPet { /** */ SINGLETON_INSTANCE; diff --git a/src/main/java/forge/gui/home/quest/VSubmenuDuels.java b/src/main/java/forge/gui/home/quest/VSubmenuDuels.java index bf5f78dc44f..978cbfd39f8 100644 --- a/src/main/java/forge/gui/home/quest/VSubmenuDuels.java +++ b/src/main/java/forge/gui/home/quest/VSubmenuDuels.java @@ -22,7 +22,11 @@ import forge.gui.toolbox.FPanel; import forge.gui.toolbox.FScrollPane; import forge.gui.toolbox.FSkin; -/** */ +/** + * Assembles Swing components of quest duels submenu singleton. + * + *

(V at beginning of class name denotes a view class.) + */ public enum VSubmenuDuels implements IVSubmenu, IStatsAndPet { /** */ SINGLETON_INSTANCE; diff --git a/src/main/java/forge/gui/home/quest/VSubmenuQuestData.java b/src/main/java/forge/gui/home/quest/VSubmenuQuestData.java index 5ce8418990e..e312819671f 100644 --- a/src/main/java/forge/gui/home/quest/VSubmenuQuestData.java +++ b/src/main/java/forge/gui/home/quest/VSubmenuQuestData.java @@ -1,26 +1,40 @@ package forge.gui.home.quest; -import forge.gui.home.EMenuGroup; -import forge.gui.home.EMenuItem; -import forge.gui.home.ICSubmenu; -import forge.gui.home.IVSubmenu; -import forge.gui.toolbox.*; -import forge.item.PreconDeck; -import forge.quest.QuestController; -import forge.util.IStorageView; -import net.miginfocom.swing.MigLayout; -import org.apache.commons.lang3.text.WordUtils; - -import javax.swing.*; -import javax.swing.plaf.basic.BasicComboBoxRenderer; import java.awt.Component; import java.awt.event.ActionEvent; import java.awt.event.ActionListener; import java.util.HashMap; import java.util.Map; +import javax.swing.ButtonGroup; +import javax.swing.JComboBox; +import javax.swing.JList; +import javax.swing.JPanel; +import javax.swing.JRadioButton; +import javax.swing.SwingConstants; +import javax.swing.plaf.basic.BasicComboBoxRenderer; + +import net.miginfocom.swing.MigLayout; + +import org.apache.commons.lang3.text.WordUtils; + +import forge.gui.home.EMenuGroup; +import forge.gui.home.EMenuItem; +import forge.gui.home.ICSubmenu; +import forge.gui.home.IVSubmenu; +import forge.gui.toolbox.FLabel; +import forge.gui.toolbox.FPanel; +import forge.gui.toolbox.FRadioButton; +import forge.gui.toolbox.FScrollPane; +import forge.gui.toolbox.FSkin; +import forge.item.PreconDeck; +import forge.quest.QuestController; +import forge.util.IStorageView; + /** - * Singleton instance of "Colors" submenu in "Constructed" group. + * Assembles Swing components of quest data submenu singleton. + * + *

(V at beginning of class name denotes a view class.) */ public enum VSubmenuQuestData implements IVSubmenu { /** */ diff --git a/src/main/java/forge/gui/home/quest/VSubmenuQuestDecks.java b/src/main/java/forge/gui/home/quest/VSubmenuQuestDecks.java index 2c44a4830cb..47c2c1642e2 100644 --- a/src/main/java/forge/gui/home/quest/VSubmenuQuestDecks.java +++ b/src/main/java/forge/gui/home/quest/VSubmenuQuestDecks.java @@ -13,7 +13,9 @@ import forge.gui.toolbox.FLabel; import forge.gui.toolbox.FScrollPane; /** - * Singleton instance of "Colors" submenu in "Constructed" group. + * Assembles Swing components of quest decks submenu singleton. + * + *

(V at beginning of class name denotes a view class.) * */ public enum VSubmenuQuestDecks implements IVSubmenu { diff --git a/src/main/java/forge/gui/home/quest/VSubmenuQuestPrefs.java b/src/main/java/forge/gui/home/quest/VSubmenuQuestPrefs.java index b6a3adf8565..916edb9758d 100644 --- a/src/main/java/forge/gui/home/quest/VSubmenuQuestPrefs.java +++ b/src/main/java/forge/gui/home/quest/VSubmenuQuestPrefs.java @@ -27,7 +27,9 @@ import forge.quest.data.QuestPreferences; import forge.quest.data.QuestPreferences.QPref; /** - * Singleton instance of "Colors" submenu in "Constructed" group. + * Assembles Swing components of quest preferences submenu singleton. + * + *

(V at beginning of class name denotes a view class.) * */ public enum VSubmenuQuestPrefs implements IVSubmenu { diff --git a/src/main/java/forge/gui/home/sanctioned/CSubmenuConstructed.java b/src/main/java/forge/gui/home/sanctioned/CSubmenuConstructed.java index f4548286780..57e1068c6ec 100644 --- a/src/main/java/forge/gui/home/sanctioned/CSubmenuConstructed.java +++ b/src/main/java/forge/gui/home/sanctioned/CSubmenuConstructed.java @@ -46,7 +46,9 @@ import forge.quest.QuestEvent; import forge.util.IStorage; /** - * TODO: Write javadoc for this type. + * Controls the constructed submenu in the home UI. + * + *

(C at beginning of class name denotes a control class.) * */ @SuppressWarnings("serial") diff --git a/src/main/java/forge/gui/home/sanctioned/CSubmenuDraft.java b/src/main/java/forge/gui/home/sanctioned/CSubmenuDraft.java index 1278161d3ea..9d2278333db 100644 --- a/src/main/java/forge/gui/home/sanctioned/CSubmenuDraft.java +++ b/src/main/java/forge/gui/home/sanctioned/CSubmenuDraft.java @@ -5,6 +5,7 @@ import java.awt.event.MouseEvent; import java.util.ArrayList; import java.util.List; import java.util.Random; + import javax.swing.JOptionPane; import javax.swing.SwingUtilities; import javax.swing.SwingWorker; @@ -25,7 +26,9 @@ import forge.gui.home.ICSubmenu; import forge.gui.toolbox.FSkin; /** - * TODO: Write javadoc for this type. + * Controls the draft submenu in the home UI. + * + *

(C at beginning of class name denotes a control class.) * */ @SuppressWarnings("serial") diff --git a/src/main/java/forge/gui/home/sanctioned/CSubmenuSealed.java b/src/main/java/forge/gui/home/sanctioned/CSubmenuSealed.java index 8dca8934460..66130168967 100644 --- a/src/main/java/forge/gui/home/sanctioned/CSubmenuSealed.java +++ b/src/main/java/forge/gui/home/sanctioned/CSubmenuSealed.java @@ -6,10 +6,13 @@ import java.util.ArrayList; import java.util.HashMap; import java.util.List; import java.util.Map; + import javax.swing.JOptionPane; import javax.swing.SwingUtilities; import javax.swing.SwingWorker; +import org.apache.commons.lang3.StringUtils; + import forge.Command; import forge.Constant; import forge.Singletons; @@ -29,10 +32,11 @@ import forge.item.ItemPool; import forge.properties.ForgeProps; import forge.properties.NewConstants; import forge.util.TextUtil; -import org.apache.commons.lang3.StringUtils; /** - * TODO: Write javadoc for this type. + * Controls the sealed submenu in the home UI. + * + *

(C at beginning of class name denotes a control class.) * */ @SuppressWarnings("serial") diff --git a/src/main/java/forge/gui/home/sanctioned/VSubmenuConstructed.java b/src/main/java/forge/gui/home/sanctioned/VSubmenuConstructed.java index 572fa3e3c64..6a5a20ebeb9 100644 --- a/src/main/java/forge/gui/home/sanctioned/VSubmenuConstructed.java +++ b/src/main/java/forge/gui/home/sanctioned/VSubmenuConstructed.java @@ -24,7 +24,9 @@ import forge.gui.toolbox.FRadioButton; import forge.gui.toolbox.FScrollPane; /** - * TODO: Write javadoc for this type. + * Assembles Swing components of constructed submenu singleton. + * + *

(V at beginning of class name denotes a view class.) * */ public enum VSubmenuConstructed implements IVSubmenu { diff --git a/src/main/java/forge/gui/home/sanctioned/VSubmenuDraft.java b/src/main/java/forge/gui/home/sanctioned/VSubmenuDraft.java index 4339e30e54c..805a20efa9e 100644 --- a/src/main/java/forge/gui/home/sanctioned/VSubmenuDraft.java +++ b/src/main/java/forge/gui/home/sanctioned/VSubmenuDraft.java @@ -33,7 +33,9 @@ import forge.gui.toolbox.FScrollPane; import forge.gui.toolbox.FSkin; /** - * Singleton instance of "Draft" submenu in "Constructed" group. + * Assembles Swing components of draft submenu singleton. + * + *

(V at beginning of class name denotes a view class.) */ public enum VSubmenuDraft implements IVSubmenu { /** */ diff --git a/src/main/java/forge/gui/home/sanctioned/VSubmenuSealed.java b/src/main/java/forge/gui/home/sanctioned/VSubmenuSealed.java index 1381be4cb0f..033c1f29365 100644 --- a/src/main/java/forge/gui/home/sanctioned/VSubmenuSealed.java +++ b/src/main/java/forge/gui/home/sanctioned/VSubmenuSealed.java @@ -30,7 +30,9 @@ import forge.gui.toolbox.FScrollPane; import forge.gui.toolbox.FSkin; /** - * Singleton instance of "Draft" submenu in "Constructed" group. + * Assembles Swing components of sealed submenu singleton. + * + *

(V at beginning of class name denotes a view class.) */ public enum VSubmenuSealed implements IVSubmenu { /** */ diff --git a/src/main/java/forge/gui/home/settings/CSubmenuAvatars.java b/src/main/java/forge/gui/home/settings/CSubmenuAvatars.java index f7c30665514..d4ae97c23bf 100644 --- a/src/main/java/forge/gui/home/settings/CSubmenuAvatars.java +++ b/src/main/java/forge/gui/home/settings/CSubmenuAvatars.java @@ -4,7 +4,9 @@ import forge.Command; import forge.gui.home.ICSubmenu; /** - * TODO: Write javadoc for this type. + * Controls the avatars submenu in the home UI. + * + *

(C at beginning of class name denotes a control class.) * */ public enum CSubmenuAvatars implements ICSubmenu { diff --git a/src/main/java/forge/gui/home/settings/CSubmenuPreferences.java b/src/main/java/forge/gui/home/settings/CSubmenuPreferences.java index d8ec3d0bcad..32f43b15835 100644 --- a/src/main/java/forge/gui/home/settings/CSubmenuPreferences.java +++ b/src/main/java/forge/gui/home/settings/CSubmenuPreferences.java @@ -17,7 +17,9 @@ import forge.properties.ForgePreferences; import forge.properties.ForgePreferences.FPref; /** - * TODO: Write javadoc for this type. + * Controls the preferences submenu in the home UI. + * + *

(C at beginning of class name denotes a control class.) * */ public enum CSubmenuPreferences implements ICSubmenu { diff --git a/src/main/java/forge/gui/home/settings/VSubmenuAvatars.java b/src/main/java/forge/gui/home/settings/VSubmenuAvatars.java index 2dda9650d56..ad89f03e05c 100644 --- a/src/main/java/forge/gui/home/settings/VSubmenuAvatars.java +++ b/src/main/java/forge/gui/home/settings/VSubmenuAvatars.java @@ -22,7 +22,9 @@ import forge.gui.toolbox.FSkin; import forge.properties.ForgePreferences.FPref; /** - * Singleton instance of "Draft" submenu in "Constructed" group. + * Assembles Swing components of avatars submenu singleton. + * + *

(V at beginning of class name denotes a view class.) */ public enum VSubmenuAvatars implements IVSubmenu { /** */ diff --git a/src/main/java/forge/gui/home/settings/VSubmenuPreferences.java b/src/main/java/forge/gui/home/settings/VSubmenuPreferences.java index 2b14e6515c8..91547bbf953 100644 --- a/src/main/java/forge/gui/home/settings/VSubmenuPreferences.java +++ b/src/main/java/forge/gui/home/settings/VSubmenuPreferences.java @@ -40,7 +40,9 @@ import forge.properties.ForgeProps; import forge.properties.NewConstants.Lang.OldGuiNewGame.NewGameText; /** - * Singleton instance of "Draft" submenu in "Constructed" group. + * Assembles Swing components of preferences submenu singleton. + * + *

(V at beginning of class name denotes a view class.) */ public enum VSubmenuPreferences implements IVSubmenu { /** */ diff --git a/src/main/java/forge/gui/home/utilities/CSubmenuDeckEditor.java b/src/main/java/forge/gui/home/utilities/CSubmenuDeckEditor.java index 1b71f4f0b5a..0e3c35af824 100644 --- a/src/main/java/forge/gui/home/utilities/CSubmenuDeckEditor.java +++ b/src/main/java/forge/gui/home/utilities/CSubmenuDeckEditor.java @@ -8,7 +8,9 @@ import forge.gui.deckeditor.DeckEditorConstructed; import forge.gui.home.ICSubmenu; /** - * TODO: Write javadoc for this type. + * Controls the deck editor submenu option in the home UI. + * + *

(C at beginning of class name denotes a control class.) * */ public enum CSubmenuDeckEditor implements ICSubmenu { diff --git a/src/main/java/forge/gui/home/utilities/CSubmenuExit.java b/src/main/java/forge/gui/home/utilities/CSubmenuExit.java index afd2f4602f2..ecd69da4af3 100644 --- a/src/main/java/forge/gui/home/utilities/CSubmenuExit.java +++ b/src/main/java/forge/gui/home/utilities/CSubmenuExit.java @@ -4,7 +4,9 @@ import forge.Command; import forge.gui.home.ICSubmenu; /** - * TODO: Write javadoc for this type. + * Controls the exit submenu option in the home UI. + * + *

(C at beginning of class name denotes a control class.) * */ public enum CSubmenuExit implements ICSubmenu { diff --git a/src/main/java/forge/gui/home/utilities/CSubmenuUtilities.java b/src/main/java/forge/gui/home/utilities/CSubmenuUtilities.java index ecc58623169..9e43cec9068 100644 --- a/src/main/java/forge/gui/home/utilities/CSubmenuUtilities.java +++ b/src/main/java/forge/gui/home/utilities/CSubmenuUtilities.java @@ -10,7 +10,9 @@ import forge.gui.download.GuiDownloadSetPicturesLQ; import forge.gui.home.ICSubmenu; /** - * TODO: Write javadoc for this type. + * Controls the utilities submenu in the home UI. + * + *

(C at beginning of class name denotes a control class.) * */ @SuppressWarnings("serial") diff --git a/src/main/java/forge/gui/home/utilities/VSubmenuDeckEditor.java b/src/main/java/forge/gui/home/utilities/VSubmenuDeckEditor.java index 5a413a76a36..5f630154716 100644 --- a/src/main/java/forge/gui/home/utilities/VSubmenuDeckEditor.java +++ b/src/main/java/forge/gui/home/utilities/VSubmenuDeckEditor.java @@ -10,7 +10,9 @@ import forge.gui.home.IVSubmenu; import forge.gui.toolbox.FLabel; /** - * Singleton instance of "Colors" submenu in "Constructed" group. + * Assembles Swing components of deck editor submenu option singleton. + * + *

(V at beginning of class name denotes a view class.) * */ public enum VSubmenuDeckEditor implements IVSubmenu { diff --git a/src/main/java/forge/gui/home/utilities/VSubmenuExit.java b/src/main/java/forge/gui/home/utilities/VSubmenuExit.java index e57a9608b1a..4134fc8342b 100644 --- a/src/main/java/forge/gui/home/utilities/VSubmenuExit.java +++ b/src/main/java/forge/gui/home/utilities/VSubmenuExit.java @@ -10,7 +10,9 @@ import forge.gui.home.IVSubmenu; import forge.gui.toolbox.FLabel; /** - * Singleton instance of "Colors" submenu in "Constructed" group. + * Assembles Swing components of exit submenu option singleton. + * + *

(V at beginning of class name denotes a view class.) * */ public enum VSubmenuExit implements IVSubmenu { diff --git a/src/main/java/forge/gui/home/utilities/VSubmenuUtilities.java b/src/main/java/forge/gui/home/utilities/VSubmenuUtilities.java index 3b3d32fde62..3d08ae76bed 100644 --- a/src/main/java/forge/gui/home/utilities/VSubmenuUtilities.java +++ b/src/main/java/forge/gui/home/utilities/VSubmenuUtilities.java @@ -33,7 +33,9 @@ import forge.properties.ForgeProps; import forge.properties.NewConstants.Lang; /** - * Singleton instance of "Colors" submenu in "Constructed" group. + * Assembles Swing components of utilities submenu singleton. + * + *

(V at beginning of class name denotes a view class.) * */ public enum VSubmenuUtilities implements IVSubmenu {