Javadoc updates.

This commit is contained in:
Doublestrike
2012-04-14 08:43:55 +00:00
parent 7faff76b3f
commit 0c2456c718
26 changed files with 111 additions and 40 deletions

View File

@@ -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.
*
* <br><br><i>(C at beginning of class name denotes a control class.)</i>
*
*/
public enum CSubmenuChallenges implements ICSubmenu {

View File

@@ -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.
*
* <br><br><i>(C at beginning of class name denotes a control class.)</i>
*
*/
public enum CSubmenuDuels implements ICSubmenu {

View File

@@ -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.
*
* <br><br><i>(C at beginning of class name denotes a control class.)</i>
*
*/
@SuppressWarnings("serial")

View File

@@ -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.
*
* <br><br><i>(C at beginning of class name denotes a control class.)</i>
*/
@SuppressWarnings("serial")
public enum CSubmenuQuestDecks implements ICSubmenu {

View File

@@ -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.
*
* <br><br><i>(C at beginning of class name denotes a control class.)</i>
*
*/
public enum CSubmenuQuestPrefs implements ICSubmenu {

View File

@@ -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.
*
* <br><br><i>(V at beginning of class name denotes a view class.)</i>
*/
public enum VSubmenuChallenges implements IVSubmenu, IStatsAndPet {
/** */
SINGLETON_INSTANCE;

View File

@@ -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.
*
* <br><br><i>(V at beginning of class name denotes a view class.)</i>
*/
public enum VSubmenuDuels implements IVSubmenu, IStatsAndPet {
/** */
SINGLETON_INSTANCE;

View File

@@ -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.
*
* <br><br><i>(V at beginning of class name denotes a view class.)</i>
*/
public enum VSubmenuQuestData implements IVSubmenu {
/** */

View File

@@ -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.
*
* <br><br><i>(V at beginning of class name denotes a view class.)</i>
*
*/
public enum VSubmenuQuestDecks implements IVSubmenu {

View File

@@ -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.
*
* <br><br><i>(V at beginning of class name denotes a view class.)</i>
*
*/
public enum VSubmenuQuestPrefs implements IVSubmenu {

View File

@@ -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.
*
* <br><br><i>(C at beginning of class name denotes a control class.)</i>
*
*/
@SuppressWarnings("serial")

View File

@@ -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.
*
* <br><br><i>(C at beginning of class name denotes a control class.)</i>
*
*/
@SuppressWarnings("serial")

View File

@@ -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.
*
* <br><br><i>(C at beginning of class name denotes a control class.)</i>
*
*/
@SuppressWarnings("serial")

View File

@@ -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.
*
* <br><br><i>(V at beginning of class name denotes a view class.)</i>
*
*/
public enum VSubmenuConstructed implements IVSubmenu {

View File

@@ -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.
*
* <br><br><i>(V at beginning of class name denotes a view class.)</i>
*/
public enum VSubmenuDraft implements IVSubmenu {
/** */

View File

@@ -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.
*
* <br><br><i>(V at beginning of class name denotes a view class.)</i>
*/
public enum VSubmenuSealed implements IVSubmenu {
/** */

View File

@@ -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.
*
* <br><br><i>(C at beginning of class name denotes a control class.)</i>
*
*/
public enum CSubmenuAvatars implements ICSubmenu {

View File

@@ -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.
*
* <br><br><i>(C at beginning of class name denotes a control class.)</i>
*
*/
public enum CSubmenuPreferences implements ICSubmenu {

View File

@@ -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.
*
* <br><br><i>(V at beginning of class name denotes a view class.)</i>
*/
public enum VSubmenuAvatars implements IVSubmenu {
/** */

View File

@@ -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.
*
* <br><br><i>(V at beginning of class name denotes a view class.)</i>
*/
public enum VSubmenuPreferences implements IVSubmenu {
/** */

View File

@@ -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.
*
* <br><br><i>(C at beginning of class name denotes a control class.)</i>
*
*/
public enum CSubmenuDeckEditor implements ICSubmenu {

View File

@@ -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.
*
* <br><br><i>(C at beginning of class name denotes a control class.)</i>
*
*/
public enum CSubmenuExit implements ICSubmenu {

View File

@@ -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.
*
* <br><br><i>(C at beginning of class name denotes a control class.)</i>
*
*/
@SuppressWarnings("serial")

View File

@@ -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.
*
* <br><br><i>(V at beginning of class name denotes a view class.)</i>
*
*/
public enum VSubmenuDeckEditor implements IVSubmenu {

View File

@@ -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.
*
* <br><br><i>(V at beginning of class name denotes a view class.)</i>
*
*/
public enum VSubmenuExit implements IVSubmenu {

View File

@@ -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.
*
* <br><br><i>(V at beginning of class name denotes a view class.)</i>
*
*/
public enum VSubmenuUtilities implements IVSubmenu {