Menu
▾
▴
[Gridarta-commit] SF.net SVN: gridarta: [1083] trunk
|
From: <aki...@us...> - 2006-12-15 22:01:25
|
Revision: 1083
http://svn.sourceforge.net/gridarta/?rev=1083&view=rev
Author: akirschbaum
Date: 2006-12-15 14:01:25 -0800 (Fri, 15 Dec 2006)
Log Message:
-----------
Unify comments.
Modified Paths:
--------------
trunk/crossfire/src/cfeditor/CAttribDialog.java
trunk/crossfire/src/cfeditor/CFArchAttrib.java
trunk/crossfire/src/cfeditor/CFArchTypeList.java
trunk/crossfire/src/cfeditor/CGUIUtils.java
trunk/crossfire/src/cfeditor/CMainControl.java
trunk/crossfire/src/cfeditor/CMainView.java
trunk/crossfire/src/cfeditor/CMapTileList.java
trunk/crossfire/src/cfeditor/CPickmapPanel.java
trunk/crossfire/src/cfeditor/CopyBuffer.java
trunk/crossfire/src/cfeditor/MapViewIFrame.java
trunk/crossfire/src/cfeditor/MultiPositionData.java
trunk/crossfire/src/cfeditor/ReplaceDialog.java
trunk/crossfire/src/cfeditor/ScriptArchData.java
trunk/daimonin/src/daieditor/CAttribDialog.java
trunk/daimonin/src/daieditor/CFArchAttrib.java
trunk/daimonin/src/daieditor/CFArchTypeList.java
trunk/daimonin/src/daieditor/CMainControl.java
trunk/daimonin/src/daieditor/CMainView.java
trunk/daimonin/src/daieditor/CMapTileList.java
trunk/daimonin/src/daieditor/CPickmapPanel.java
trunk/daimonin/src/daieditor/IGUIConstants.java
trunk/daimonin/src/daieditor/MapViewIFrame.java
trunk/daimonin/src/daieditor/MultiPositionData.java
trunk/daimonin/src/daieditor/ReplaceDialog.java
trunk/daimonin/src/daieditor/ScriptArchData.java
trunk/daimonin/src/daieditor/gameobject/ArchetypeSet.java
Modified: trunk/crossfire/src/cfeditor/CAttribDialog.java
===================================================================
--- trunk/crossfire/src/cfeditor/CAttribDialog.java 2006-12-15 21:06:55 UTC (rev 1082)
+++ trunk/crossfire/src/cfeditor/CAttribDialog.java 2006-12-15 22:01:25 UTC (rev 1083)
@@ -1330,7 +1330,7 @@
imagePanel.setIcon(mainControl.getArchetypeSet().getFace(gameObject.getFaceNr()));
if (newMsg != null) {
- // set new msg text only when it is not equal to default gameObject
+ // set new msg text only when it is not equal to Archetype
if (!newMsg.trim().equals(archetype.getMsgText() == null ? "" : archetype.getMsgText().trim())) {
gameObject.deleteMsgText();
gameObject.addMsgText(newMsg);
Modified: trunk/crossfire/src/cfeditor/CFArchAttrib.java
===================================================================
--- trunk/crossfire/src/cfeditor/CFArchAttrib.java 2006-12-15 21:06:55 UTC (rev 1082)
+++ trunk/crossfire/src/cfeditor/CFArchAttrib.java 2006-12-15 22:01:25 UTC (rev 1083)
@@ -59,7 +59,7 @@
private String nameOld; // original attr. name (from the CF arches)
- private String endingOld; // for dataType = 'ArchAttribType.TEXT' this is the terminating string
+ private String endingOld; // for dataType = ArchAttribType.TEXT this is the terminating string
// (example: 'endmsg' for arch message)
private String nameNew; // new attr. name (for the user-friendly GUI)
Modified: trunk/crossfire/src/cfeditor/CFArchTypeList.java
===================================================================
--- trunk/crossfire/src/cfeditor/CFArchTypeList.java 2006-12-15 21:06:55 UTC (rev 1082)
+++ trunk/crossfire/src/cfeditor/CFArchTypeList.java 2006-12-15 22:01:25 UTC (rev 1083)
@@ -256,7 +256,7 @@
/**
* Parse a list vector from an xml list element.
* @param root element to parse
- * @return List with data parsed from <var>root</var>.
+ * @return List with data parsed from <var>root</var>
*/
private List<?> parseListFromElement(final Element root) {
final List<Object> list = new ArrayList<Object>();
Modified: trunk/crossfire/src/cfeditor/CGUIUtils.java
===================================================================
--- trunk/crossfire/src/cfeditor/CGUIUtils.java 2006-12-15 21:06:55 UTC (rev 1082)
+++ trunk/crossfire/src/cfeditor/CGUIUtils.java 2006-12-15 22:01:25 UTC (rev 1083)
@@ -54,6 +54,7 @@
private static final Map<String, ImageIcon> imageCache = new HashMap<String, ImageIcon>();
+ /** Do not subclass. */
private CGUIUtils() {
}
Modified: trunk/crossfire/src/cfeditor/CMainControl.java
===================================================================
--- trunk/crossfire/src/cfeditor/CMainControl.java 2006-12-15 21:06:55 UTC (rev 1082)
+++ trunk/crossfire/src/cfeditor/CMainControl.java 2006-12-15 22:01:25 UTC (rev 1083)
@@ -966,7 +966,7 @@
/**
* Browse first through the default arch list and attach map arches to it
* then browse through the face list and try to find the pictures.
- * @param objects GameObjects to collect.
+ * @param objects List of GameObjects to collect
* @param file File (for error messages).
* @return <code>true</code> in case of success, otherwise <code>false</code>.
* @note The current implementation always returns <code>true</code>.
Modified: trunk/crossfire/src/cfeditor/CMainView.java
===================================================================
--- trunk/crossfire/src/cfeditor/CMainView.java 2006-12-15 21:06:55 UTC (rev 1082)
+++ trunk/crossfire/src/cfeditor/CMainView.java 2006-12-15 22:01:25 UTC (rev 1083)
@@ -161,7 +161,7 @@
/**
* Constructs the main view and registers the given main controller.
- * @param mainControl The controller of this view.
+ * @param mainControl the controller of this view
*/
CMainView() {
super(IGUIConstants.APP_NAME + " - " + IGUIConstants.APP_WINDOW_TITLE);
@@ -183,7 +183,7 @@
/**
* Initialises (builds) this view.
- * @param doShow <code>true</code> whether to show, otherwise <code>false</code>.
+ * @param doShow <code>true</code> whether to show, otherwise <code>false</code>
*/
void init(final boolean doShow) {
final CSettings settings = CSettings.getInstance(IGUIConstants.APP_NAME);
@@ -306,8 +306,8 @@
}
/**
- * Returns whether selection would be from a pickmap (otherwise it would be from the archlist).
- * @return <code>true</code> if selection would be from a pickmap, <code>false</code> for the archlist.
+ * Returns whether a pickmap is active.
+ * @return <code>true</code> if a pickmap is active, <code>false</code> if the archlist is active
*/
public boolean isPickmapActive() {
return pickmapActive;
@@ -323,12 +323,12 @@
}
/**
- * Returns the highlighted Archetype / GameObject.
- * @return the active arch in the left-side panel.
- * This can either be a Archetype from the archlist, or
- * a custom GameObject from a pickmap.
- * IMPORTANT: The returned GameObject is not a clone. A copy
- * must be generated before inserting such an arch to the map.
+ * Returns the active arch in the left-side panel.
+ * This can either be a default arch from the archlist, or
+ * a custom arch from a pickmap.
+ * IMPORTANT: The returned GameObject is not a clone. A copy
+ * must be generated before inserting such an arch to the map.
+ * @return the active arch in the left-side panel
*/
public GameObject getArchPanelHighlight() {
@@ -360,7 +360,7 @@
/**
* Returns the JTabbedPane with all pickmaps.
- * @return The JTabbedPane with all pickmaps.
+ * @return the JTabbedPane with all pickmaps
*/
public JTabbedPane getPickmapPanel() {
return pickmapPanel;
@@ -395,7 +395,7 @@
/**
* Sets the enabled state of the tab pane for Archetypes.
- * @param tabPaneEnabled <code>true</code> to enable tab pane, <code>false</code> to disable it.
+ * @param tabPaneEnabled <code>true</code> to enable tab pane, <code>false</code> to disable it
*/
public void setTabPaneEnabled(final boolean tabPaneEnabled) {
archPanel.setTabPaneEnabled(tabPaneEnabled);
@@ -462,7 +462,7 @@
}
/**
- * Refreshes the state of menu items and toolbar buttons.
+ * Refresh the state of menu items and toolbar buttons.
* Beware!! Executing this function eats up a lot of time!
* Avoid using it whenever possible.
*/
@@ -476,7 +476,7 @@
refresh3();
}
- /** Refreshes the map arch panel (bottom window). */
+ /** Refresh the map arch panel (bottom window). */
void refreshMapArchPanel() {
mapArchPanel.refresh();
}
@@ -492,7 +492,7 @@
aSave.setEnabled(state && mainControl.isPlainSaveEnabled());
}
- /** Refreshes the state of the menu only. */
+ /** Refresh the state of the menu only. */
public void refreshMenus() {
// TODO: This method shouldn't really be invoked.
// Each action should be setEnabled() individually as needed.
@@ -531,7 +531,7 @@
/**
* Removes (closes) the level view.
- * @param mapView the map view to be removed (closed).
+ * @param mapView the map view to be removed (closed)
*/
void removeLevelView(final MapViewIFrame mapView) {
if (!mapViews.contains(mapView)) {
@@ -576,9 +576,9 @@
/**
* Shows the given message in the UI.
- * @param strTitle The title of the message.
- * @param strMessage The message to be shown.
- * @param messageType Type of message (see JOptionPane constants), defines icon used
+ * @param strTitle the title of the message
+ * @param strMessage the message to be shown
+ * @param messageType type of message (see JOptionPane constants), defines icon used
*/
public void showMessage(final String strTitle, final String strMessage, final int messageType) {
JOptionPane.showMessageDialog(this, strMessage, strTitle, messageType);
@@ -591,9 +591,9 @@
/**
* Shows the given confirmation message in the UI. The message
* is a yes/no option.
- * @param strTitle The title of the message.
- * @param strMessage The message to be shown.
- * @return Ture if the user agrees, false if user disagrees.
+ * @param strTitle the title of the message
+ * @param strMessage the message to be shown
+ * @return <code>true</code> if the user agrees, <code>false</code> if user disagrees
*/
public boolean askConfirm(final String strTitle, final String strMessage) {
return JOptionPane.showConfirmDialog(this, strMessage, strTitle, JOptionPane.YES_NO_OPTION, JOptionPane.INFORMATION_MESSAGE) == JOptionPane.YES_OPTION;
@@ -655,7 +655,7 @@
/**
* Sets the given level view as the current one.
- * @param view The new current level view.
+ * @param view the new current level view
*/
public void setCurrentLevelView(final MapViewIFrame view) {
mapViews.remove(view);
@@ -676,7 +676,7 @@
/**
* Notifies that the level views focus is lost it is inserted
* as the second in line to the level view vector.
- * @param view The level view who lost the focus.
+ * @param view the level view who lost the focus
*/
public void levelViewFocusLostNotify(final MapViewIFrame view) {
@@ -689,7 +689,7 @@
/**
* Notifies that the given level view is now set as the current one.
- * @param view The new current level view.
+ * @param view the new current level view
*/
public void levelViewFocusGainedNotify(final MapViewIFrame view) {
@@ -743,7 +743,7 @@
}
/**
- * Rebuild the "window" menu.
+ * Rebuild the window menu.
*/
private void rebuildWindowMenu() {
final JMenu menuWindow = (JMenu) ACTION_FACTORY.find(getJMenuBar(), "window");
@@ -761,7 +761,7 @@
}
/**
- * Rebuild the "look and feel" menu entries in the view menu.
+ * Rebuild the look and feel menu entries in the view menu.
*/
private void rebuildLookAndFeelMenuEntries() {
final JMenu menuView = (JMenu) ACTION_FACTORY.find(getJMenuBar(), "view");
Modified: trunk/crossfire/src/cfeditor/CMapTileList.java
===================================================================
--- trunk/crossfire/src/cfeditor/CMapTileList.java 2006-12-15 21:06:55 UTC (rev 1082)
+++ trunk/crossfire/src/cfeditor/CMapTileList.java 2006-12-15 22:01:25 UTC (rev 1083)
@@ -241,8 +241,8 @@
}
/**
- * Returns the selected GameObject within this list (currently selected square).
- * @return The selected GameObject within this list.
+ * Return the currently selected GameObject within this list (currently selected MapSquare).
+ * @return the currently selected GameObject
*/
@Nullable public GameObject getMapTileSelection() {
return (GameObject) list.getSelectedValue();
Modified: trunk/crossfire/src/cfeditor/CPickmapPanel.java
===================================================================
--- trunk/crossfire/src/cfeditor/CPickmapPanel.java 2006-12-15 21:06:55 UTC (rev 1082)
+++ trunk/crossfire/src/cfeditor/CPickmapPanel.java 2006-12-15 22:01:25 UTC (rev 1083)
@@ -69,7 +69,9 @@
/** The current active pickmap ontop. */
private MapControl currentPickMap;
- /** Creates a PickmapPanel. */
+ /**
+ * Create a CPickmapPanel.
+ */
public CPickmapPanel() {
mainControl = CMainControl.getInstance();
instance = this;
@@ -78,16 +80,16 @@
}
/**
- * Returns the singleton instance of this class.
- * @return The singleton instance of this class.
+ * Return the singleton instance of this class.
+ * @return the singleton instance of this class
*/
public static CPickmapPanel getInstance() {
return instance;
}
/**
- * Returns whether the loading process of pickmaps is complete and at least one pickmap is available.
- * @return <code>true</code> if pickmaps are loaded, otherwise <code>false</code>
+ * Return whether loading of pickmaps is complete and at least one pickmap is available.
+ * @return <code>true</code> if loading of pickmaps is complete and at least one pickmap is available, otherwise <code>false</code>
* @todo check whether this method returns <code>true</code> or <code>false</code> if the loading process is complete but no pickmaps are availbale.
*/
public boolean isLoadComplete() {
@@ -95,15 +97,17 @@
}
/**
- * Returns the currently active pickmap.
+ * Return the currently active pickmap.
* If there is no currently active pickmap, this method returns <code>null</code>.
- * @return Currently active pickmap or <code>null</code> if there are no pickmaps.
+ * @return the currently active pickmap or <code>null</code> if there is no pickmap
*/
public MapControl getCurrentPickmap() {
return currentPickMap;
}
- /** Load all pickmaps and build the pickmap-panel in the process. */
+ /**
+ * Load all pickmaps and build the pickmap-panel.
+ */
public void loadPickmaps() {
// the main-panel for pickmaps:
tabpane = mainControl.getMainView().getPickmapPanel();
@@ -311,7 +315,7 @@
/**
* Add the ArchNPickChangeListener to the panel containing both
- * arcglist and pickmaps.
+ * archlist and pickmaps.
* @param pane the left-side panel
* @todo this method's name is a Bad Thing
*/
@@ -355,7 +359,7 @@
private int selectedIndex; // current state of selection
/**
- * Create a new ArchNPickChangeListener.
+ * Create an ArchNPickChangeListener.
* @param mainView the main view
* @param pane the JTabbedPane containing both archlist and pickmaps
*/
Modified: trunk/crossfire/src/cfeditor/CopyBuffer.java
===================================================================
--- trunk/crossfire/src/cfeditor/CopyBuffer.java 2006-12-15 21:06:55 UTC (rev 1082)
+++ trunk/crossfire/src/cfeditor/CopyBuffer.java 2006-12-15 22:01:25 UTC (rev 1083)
@@ -39,8 +39,7 @@
/**
* This class manages the cut/copy/paste actions in maps. The data is stored in
- * an ordinary but invisible map-object. The CopyBuffer instance is currently
- * attached to CMainControl.
+ * an ordinary but invisible map-object.
* @author <a href="mailto:and...@gm...">Andreas Vogl</a>
*/
public final class CopyBuffer {
Modified: trunk/crossfire/src/cfeditor/MapViewIFrame.java
===================================================================
--- trunk/crossfire/src/cfeditor/MapViewIFrame.java 2006-12-15 21:06:55 UTC (rev 1082)
+++ trunk/crossfire/src/cfeditor/MapViewIFrame.java 2006-12-15 22:01:25 UTC (rev 1083)
@@ -207,7 +207,7 @@
}
/**
- * Returns the Action for selecting this window.
+ * Return the Action for selecting this window.
* @return the Action for selecting this window
*/
public WindowAction getWindowAction() {
Modified: trunk/crossfire/src/cfeditor/MultiPositionData.java
===================================================================
--- trunk/crossfire/src/cfeditor/MultiPositionData.java 2006-12-15 21:06:55 UTC (rev 1082)
+++ trunk/crossfire/src/cfeditor/MultiPositionData.java 2006-12-15 22:01:25 UTC (rev 1083)
@@ -41,10 +41,10 @@
private static final Logger log = Logger.getLogger(MultiPositionData.class);
- /** Number of rows and columns in the array. */
+ /** Number of columns in the array. */
public static final int X_DIM = 34;
- /** Number of rows and columns in the array. */
+ /** Number of rows in the array. */
public static final int Y_DIM = 16;
private static MultiPositionData instance = null;
@@ -120,7 +120,7 @@
log.info("Loaded multipart position data from '" + IGUIConstants.ARCHDEF_FILE + "'");
}
} catch (final IOException e) {
- /* TODO ignore (really?) */
+ // FIXME either do something or DOCUMENT TO IGNORE ME
}
}
Modified: trunk/crossfire/src/cfeditor/ReplaceDialog.java
===================================================================
--- trunk/crossfire/src/cfeditor/ReplaceDialog.java 2006-12-15 21:06:55 UTC (rev 1082)
+++ trunk/crossfire/src/cfeditor/ReplaceDialog.java 2006-12-15 22:01:25 UTC (rev 1083)
@@ -109,7 +109,7 @@
/**
* Returns whether this frame has been fully built.
- * @return <code>true</code> when if this frame has been fully built, otherwise <code>false</code>.
+ * @return <code>true</code> if this frame has been fully built, otherwise <code>false</code>
*/
public static boolean isBuilt() {
return instance != null && instance.isBuilt;
Modified: trunk/crossfire/src/cfeditor/ScriptArchData.java
===================================================================
--- trunk/crossfire/src/cfeditor/ScriptArchData.java 2006-12-15 21:06:55 UTC (rev 1082)
+++ trunk/crossfire/src/cfeditor/ScriptArchData.java 2006-12-15 22:01:25 UTC (rev 1083)
@@ -368,9 +368,9 @@
/**
* A popup is opened and the user can create a new scripting event
- * which gets attached to this arch.
- * @param panelList JList from the MapArchPanel (script tab) which displays the events
- * @param arch GameObject that's name should be used for creating a reasonable default script name.
+ * which gets attached to this gameObject.
+ * @param panelList JList from the MapArchPanel (script tab) which displays the events
+ * @param arch GameObject that's name should be used for creating a reasonable default script name
*/
public void addEventScript(final JList panelList, final GameObject arch) {
final String archName = arch.getBestName();
Modified: trunk/daimonin/src/daieditor/CAttribDialog.java
===================================================================
--- trunk/daimonin/src/daieditor/CAttribDialog.java 2006-12-15 21:06:55 UTC (rev 1082)
+++ trunk/daimonin/src/daieditor/CAttribDialog.java 2006-12-15 22:01:25 UTC (rev 1083)
@@ -365,7 +365,7 @@
}
/**
- * Construct the Combo box for arrays of "list data" (this is used for LIST).
+ * Construct the Combo box for arrays of "list data" (this is used for ArchAttribType.LIST).
* @param attr list attribute
* @param listData List with list items and corresponding values, that means the types are altering: String,Integer
* @return the completed <code>JComboBox</code>
Modified: trunk/daimonin/src/daieditor/CFArchAttrib.java
===================================================================
--- trunk/daimonin/src/daieditor/CFArchAttrib.java 2006-12-15 21:06:55 UTC (rev 1082)
+++ trunk/daimonin/src/daieditor/CFArchAttrib.java 2006-12-15 22:01:25 UTC (rev 1083)
@@ -74,7 +74,9 @@
private String section; // name of the section this attribute is in
- /** Constructor. */
+ /**
+ * Create a CFArchAttrib.
+ */
public CFArchAttrib() {
nameOld = "";
nameNew = "";
Modified: trunk/daimonin/src/daieditor/CFArchTypeList.java
===================================================================
--- trunk/daimonin/src/daieditor/CFArchTypeList.java 2006-12-15 21:06:55 UTC (rev 1082)
+++ trunk/daimonin/src/daieditor/CFArchTypeList.java 2006-12-15 22:01:25 UTC (rev 1083)
@@ -87,7 +87,6 @@
private final CFArchType defaultArchType = new CFArchType(null); // contains default type
private final List<CFArchType> archTypeList = new ArrayList<CFArchType>(); // All but the default ArchType
- // spell info:
/**
* Table with CAttribBitmask objects (value) accessible by name (key).
Modified: trunk/daimonin/src/daieditor/CMainControl.java
===================================================================
--- trunk/daimonin/src/daieditor/CMainControl.java 2006-12-15 21:06:55 UTC (rev 1082)
+++ trunk/daimonin/src/daieditor/CMainControl.java 2006-12-15 22:01:25 UTC (rev 1083)
@@ -1237,7 +1237,7 @@
/**
* Browse first through the default arch list and attach map arches to it
* then browse through the face list and try to find the pictures.
- * @param objects List of GameObjects to collect.
+ * @param objects List of GameObjects to collect
* @param uri URI they were read from (for error messages).
*/
public void collectTempList(final List<GameObject> objects, final String uri) {
Modified: trunk/daimonin/src/daieditor/CMainView.java
===================================================================
--- trunk/daimonin/src/daieditor/CMainView.java 2006-12-15 21:06:55 UTC (rev 1082)
+++ trunk/daimonin/src/daieditor/CMainView.java 2006-12-15 22:01:25 UTC (rev 1083)
@@ -202,7 +202,7 @@
* @param prefs Preferences
* @param defwidth default width
* @param defheight default height
- * @return Center panel.
+ * @return center panel
*/
private JPanel createCenterPanel(final Preferences prefs, final int defwidth, final int defheight) {
final JPanel centerPanel = new JPanel(new BorderLayout());
@@ -257,7 +257,7 @@
/**
* Returns whether a pickmap is active.
- * @return <code>true</code> if a pickmap is active, <code>false</code> if the archlist is active.
+ * @return <code>true</code> if a pickmap is active, <code>false</code> if the archlist is active
*/
public boolean isPickmapActive() {
return pickmapActive;
@@ -274,7 +274,7 @@
* a custom arch from a pickmap.
* IMPORTANT: The returned GameObject is not a clone. A copy
* must be generated before inserting such an arch to the map.
- * @return the active arch in the left-side panel.
+ * @return the active arch in the left-side panel
*/
@Nullable public GameObject getArchPanelHighlight() {
@@ -309,7 +309,7 @@
* custom arches from a pickmap.
* IMPORTANT: The returned GameObject list contains no clone. A copy
* must be generated before inserting such arches to the map.
- * @return the selected arches in the left-side panel.
+ * @return the selected arches in the left-side panel
*/
@Nullable public List<GameObject> getArchPanelSelection() {
@@ -339,7 +339,7 @@
/**
* Returns the JTabbedPane with all pickmaps.
- * @return The JTabbedPane with all pickmaps.
+ * @return the JTabbedPane with all pickmaps
*/
public JTabbedPane getPickmapPanel() {
return pickmapPanel;
@@ -369,7 +369,7 @@
/**
* Sets the enabled state of the tab pane for Archetypes.
- * @param tabPaneEnabled <code>true</code> to enable tab pane, <code>false</code> to disable it.
+ * @param tabPaneEnabled <code>true</code> to enable tab pane, <code>false</code> to disable it
*/
public void setTabPaneEnabled(final boolean tabPaneEnabled) {
archPanel.setTabPaneEnabled(tabPaneEnabled);
@@ -435,7 +435,7 @@
}
/**
- * Refreshes the state of menu items and toolbar buttons.
+ * Refresh the state of menu items and toolbar buttons.
* Beware!! Executing this function eats up a lot of time!
* Avoid using it whenever possible.
*/
@@ -457,7 +457,7 @@
aRevert.setEnabled(state);
}
- /** Refreshes the state of the menu only. */
+ /** Refresh the state of the menu only. */
public void refreshMenus() {
// TODO: This method shouldn't really be invoked.
// Each action should be setEnabled() individually as needed.
@@ -484,7 +484,7 @@
/**
* Removes (closes) the level view.
- * @param mapView the map view to be removed (closed).
+ * @param mapView the map view to be removed (closed)
*/
public void removeLevelView(final MapViewIFrame mapView) {
assert mapViews.contains(mapView);
@@ -580,7 +580,7 @@
/**
* Sets the given level view as the current one.
- * @param view The new current level view.
+ * @param view the new current level view
*/
public void setCurrentLevelView(final MapViewIFrame view) {
mapViews.remove(view);
@@ -607,7 +607,7 @@
/**
* Notifies that the level views focus is lost it is inserted
* as the second in line to the level view vector.
- * @param view The level view who lost the focus.
+ * @param view the level view who lost the focus
*/
public void levelViewFocusLostNotify(final MapViewIFrame view) {
@@ -620,7 +620,7 @@
/**
* Notifies that the given level view is now set as the current one.
- * @param view The new current level view.
+ * @param view the new current level view
*/
public void levelViewFocusGainedNotify(final MapViewIFrame view) {
@@ -667,7 +667,7 @@
/**
* Update the recent menu.
- * @param recents Current recents.
+ * @param recents current recents
*/
public void updateRecent(final List<CMainControl.Recent> recents) {
final JMenu recentMenu = (JMenu) ACTION_FACTORY.find(getJMenuBar(), "recent");
@@ -677,7 +677,9 @@
}
}
- /** Rebuilds the window menu. */
+ /**
+ * Rebuild the window menu.
+ */
private void rebuildWindowMenu() {
final JMenu menuWindow = (JMenu) ACTION_FACTORY.find(getJMenuBar(), "window");
menuWindow.removeAll();
Modified: trunk/daimonin/src/daieditor/CMapTileList.java
===================================================================
--- trunk/daimonin/src/daieditor/CMapTileList.java 2006-12-15 21:06:55 UTC (rev 1082)
+++ trunk/daimonin/src/daieditor/CMapTileList.java 2006-12-15 22:01:25 UTC (rev 1083)
@@ -280,8 +280,8 @@
}
/**
- * Returns the currently selected GameObject within this list (currently selected MapSquare).
- * @return The currently selected GameObject.
+ * Return the currently selected GameObject within this list (currently selected MapSquare).
+ * @return the currently selected GameObject
*/
public GameObject getMapTileSelection() {
return (GameObject) list.getSelectedValue();
Modified: trunk/daimonin/src/daieditor/CPickmapPanel.java
===================================================================
--- trunk/daimonin/src/daieditor/CPickmapPanel.java 2006-12-15 21:06:55 UTC (rev 1082)
+++ trunk/daimonin/src/daieditor/CPickmapPanel.java 2006-12-15 22:01:25 UTC (rev 1083)
@@ -68,7 +68,7 @@
private MapControl currentPickMap;
/**
- * Creates a CPickmapPanel.
+ * Create a CPickmapPanel.
*/
public CPickmapPanel() {
mainControl = CMainControl.getInstance();
@@ -78,31 +78,31 @@
}
/**
- * Returns the Singleton instance of this class.
- * @return The Singleton instance of this class.
+ * Return the singleton instance of this class.
+ * @return the singleton instance of this class
*/
public static CPickmapPanel getInstance() {
return instance;
}
/**
- * Returns whether loading of pickmaps is complete and at least one pickmap is available.
- * @return <code>true</code> if loading of pickmaps is complete and at least one pickmap is available, otherwise <code>false</code>.
+ * Return whether loading of pickmaps is complete and at least one pickmap is available.
+ * @return <code>true</code> if loading of pickmaps is complete and at least one pickmap is available, otherwise <code>false</code>
*/
public boolean isLoadComplete() {
return loadComplete;
}
/**
- * Returns the currently active pickmap (is on top).
- * @return The currently active pickmap or <code>null</code> if there is no pickmap.
+ * Return the currently active pickmap (is on top).
+ * @return the currently active pickmap or <code>null</code> if there is no pickmap
*/
public MapControl getCurrentPickmap() {
return currentPickMap;
}
/**
- * Loads all pickmaps and builds the pickmap-panel.
+ * Load all pickmaps and build the pickmap-panel.
*/
public void loadPickmaps() {
// the main-panel for pickmaps:
@@ -343,8 +343,8 @@
}
/**
- * Add the ArchNPickChangeListener to the panel containing both.
- * arcglist and pickmaps.
+ * Add the ArchNPickChangeListener to the panel containing both
+ * archlist and pickmaps.
* @param pane the left-side panel
* @todo this method's name is a Bad Thing
*/
@@ -390,7 +390,7 @@
private int selectedIndex; // current state of selection
/**
- * Creates an ArchNPickChangeListener.
+ * Create an ArchNPickChangeListener.
* @param mainView the main view
* @param pane the JTabbedPane containing both archlist and pickmaps
*/
Modified: trunk/daimonin/src/daieditor/IGUIConstants.java
===================================================================
--- trunk/daimonin/src/daieditor/IGUIConstants.java 2006-12-15 21:06:55 UTC (rev 1082)
+++ trunk/daimonin/src/daieditor/IGUIConstants.java 2006-12-15 22:01:25 UTC (rev 1083)
@@ -40,7 +40,7 @@
/**
* Internal version number of the included online-documentation.
* Increasing the number causes an automated popup of the docu
- * when users upgrade their editor and run for the first time
+ * when users upgrade their editor and run for the first time.
*/
int DOCU_VERSION = 1;
Modified: trunk/daimonin/src/daieditor/MapViewIFrame.java
===================================================================
--- trunk/daimonin/src/daieditor/MapViewIFrame.java 2006-12-15 21:06:55 UTC (rev 1082)
+++ trunk/daimonin/src/daieditor/MapViewIFrame.java 2006-12-15 22:01:25 UTC (rev 1083)
@@ -141,8 +141,8 @@
}
/**
- * Returns the Action for selecting this Window.
- * @return The Action for selecting this Window.
+ * Return the Action for selecting this window.
+ * @return the Action for selecting this window
*/
public WindowAction getWindowAction() {
return windowAction;
@@ -152,7 +152,7 @@
return view;
}
- /** Action class for selecting this Window. */
+ /** Action class for selecting this window. */
public final class WindowAction extends AbstractAction {
/** Constructor. */
Modified: trunk/daimonin/src/daieditor/MultiPositionData.java
===================================================================
--- trunk/daimonin/src/daieditor/MultiPositionData.java 2006-12-15 21:06:55 UTC (rev 1082)
+++ trunk/daimonin/src/daieditor/MultiPositionData.java 2006-12-15 22:01:25 UTC (rev 1083)
@@ -79,7 +79,7 @@
try {
final Dimension d = new Dimension();
final Point p = new Point();
- int yp = 0; // y-index in the data array
+ int yp = 0; // y-index in the data array
// read the whole file line by line
for (String line; (line = reader.readLine()) != null;) {
Modified: trunk/daimonin/src/daieditor/ReplaceDialog.java
===================================================================
--- trunk/daimonin/src/daieditor/ReplaceDialog.java 2006-12-15 21:06:55 UTC (rev 1082)
+++ trunk/daimonin/src/daieditor/ReplaceDialog.java 2006-12-15 22:01:25 UTC (rev 1083)
@@ -115,7 +115,7 @@
/**
* Returns whether this frame has been fully built.
- * @return <code>true</code> if this frame has been fully built, otherwise <code>false</code>.
+ * @return <code>true</code> if this frame has been fully built, otherwise <code>false</code>
*/
public static boolean isBuilt() {
return instance != null && instance.isBuilt;
Modified: trunk/daimonin/src/daieditor/ScriptArchData.java
===================================================================
--- trunk/daimonin/src/daieditor/ScriptArchData.java 2006-12-15 21:06:55 UTC (rev 1082)
+++ trunk/daimonin/src/daieditor/ScriptArchData.java 2006-12-15 22:01:25 UTC (rev 1083)
@@ -241,7 +241,7 @@
}
/**
- * Try to create a reasonable default script name for lazy users :-).
+ * Try to create a reasonable default script name for lazy users.
* @param archName the best suitable name for the arch (see GameObject.getBestName())
* @return a nice default script name without whitespaces
*/
@@ -324,8 +324,8 @@
/**
* A popup is opened and the user can create a new scripting event
* which gets attached to this gameObject.
- * @param panelList JList from the MapArchPanel (script tab) which displays the events
- * @param gameObject GameObject to add event to.
+ * @param panelList JList from the MapArchPanel (script tab) which displays the events
+ * @param gameObject GameObject to add event to
* @return <code>true</code> if a script was added, <code>false</code> if the user cancelled
*/
public boolean addEventScript(final JList panelList, final GameObject gameObject) {
Modified: trunk/daimonin/src/daieditor/gameobject/ArchetypeSet.java
===================================================================
--- trunk/daimonin/src/daieditor/gameobject/ArchetypeSet.java 2006-12-15 21:06:55 UTC (rev 1082)
+++ trunk/daimonin/src/daieditor/gameobject/ArchetypeSet.java 2006-12-15 22:01:25 UTC (rev 1083)
@@ -81,7 +81,7 @@
private List<File> animFiles;
/**
- * Create the GameObject stack.
+ * Create the ArchetypeSet.
* @param mainControl reference to CMainControl
*/
public ArchetypeSet(final CMainControl mainControl) {
This was sent by the SourceForge.net collaborative development platform, the world's largest Open Source development site.
|
