Menu
▾
▴
[Gridarta-commit] SF.net SVN: gridarta: [4244] trunk
|
From: <aki...@us...> - 2008-07-05 05:49:59
|
Revision: 4244
http://gridarta.svn.sourceforge.net/gridarta/?rev=4244&view=rev
Author: akirschbaum
Date: 2008-07-04 22:49:57 -0700 (Fri, 04 Jul 2008)
Log Message:
-----------
Fix Javadoc issues.
Modified Paths:
--------------
trunk/crossfire/src/cfeditor/MapActions.java
trunk/daimonin/src/daieditor/MapActions.java
trunk/daimonin/src/daieditor/gameobject/ArchetypeSet.java
trunk/daimonin/src/test/daieditor/map/MapArchObjectTest.java
trunk/src/app/net/sf/gridarta/gameobject/ArchetypeParser.java
trunk/src/app/net/sf/gridarta/gameobject/GameObject.java
trunk/src/app/net/sf/gridarta/gui/ErrorListView.java
trunk/src/app/net/sf/gridarta/gui/findarchetypes/TableModel.java
trunk/src/app/net/sf/gridarta/gui/map/MapViewBasic.java
trunk/src/app/net/sf/gridarta/gui/pickmapchooser/Loader.java
trunk/src/app/net/sf/gridarta/gui/pickmapchooser/PickmapChooserControl.java
trunk/src/app/net/sf/gridarta/io/AbstractGameObjectParser.java
trunk/src/app/net/sf/gridarta/io/AbstractMapArchObjectParser.java
trunk/src/app/net/sf/gridarta/map/validation/checks/UndefinedArchetypeError.java
trunk/src/app/net/sf/gridarta/textedit/textarea/tokenmarker/KeywordMap.java
trunk/src/app/net/sf/gridarta/textedit/textarea/tokenmarker/TokenMarkerFactory.java
trunk/src/app/net/sf/gridarta/treasurelist/TreasureLoader.java
Modified: trunk/crossfire/src/cfeditor/MapActions.java
===================================================================
--- trunk/crossfire/src/cfeditor/MapActions.java 2008-07-05 05:29:45 UTC (rev 4243)
+++ trunk/crossfire/src/cfeditor/MapActions.java 2008-07-05 05:49:57 UTC (rev 4244)
@@ -117,7 +117,7 @@
* Create a new instance.
* @param mainControl the main control to use
* @param mapManager the map manager
- * @param GameObjectMatchers the game object matchers
+ * @param exitMatcher the game object matcher selecting exit objects
*/
public MapActions(final CMainControl mainControl, final MapManager<GameObject, MapArchObject, Archetype, CMapViewBasic> mapManager, final GameObjectMatcher exitMatcher) {
this.mainControl = mainControl;
Modified: trunk/daimonin/src/daieditor/MapActions.java
===================================================================
--- trunk/daimonin/src/daieditor/MapActions.java 2008-07-05 05:29:45 UTC (rev 4243)
+++ trunk/daimonin/src/daieditor/MapActions.java 2008-07-05 05:49:57 UTC (rev 4244)
@@ -113,7 +113,7 @@
* Create a new instance.
* @param mainControl the main control to use
* @param mapManager the map manager
- * @param GameObjectMatchers the game object matchers
+ * @param exitMatcher the game object matcher selecting exit objects
*/
public MapActions(final CMainControl mainControl, final MapManager<GameObject, MapArchObject, Archetype, CMapViewBasic> mapManager, final GameObjectMatcher exitMatcher) {
this.mainControl = mainControl;
Modified: trunk/daimonin/src/daieditor/gameobject/ArchetypeSet.java
===================================================================
--- trunk/daimonin/src/daieditor/gameobject/ArchetypeSet.java 2008-07-05 05:29:45 UTC (rev 4243)
+++ trunk/daimonin/src/daieditor/gameobject/ArchetypeSet.java 2008-07-05 05:49:57 UTC (rev 4244)
@@ -407,8 +407,8 @@
* This method loads animations that are separately defined by looping
* through all files that were previously collected by {@link
* #loadArchetypesFromFiles(AbstractArchetypeParser, File, int, String,
- * String, boolean)}. Do not invoke this method if loadArchFromFiles()
- * wasn't invoked.
+ * String, boolean, List)}. Do not invoke this method if
+ * <code>loadArchetypesFromFiles()</code> wasn't invoked.
*/
private void loadAnimsFromFiles() {
for (final File animFile : animFiles) {
Modified: trunk/daimonin/src/test/daieditor/map/MapArchObjectTest.java
===================================================================
--- trunk/daimonin/src/test/daieditor/map/MapArchObjectTest.java 2008-07-05 05:29:45 UTC (rev 4243)
+++ trunk/daimonin/src/test/daieditor/map/MapArchObjectTest.java 2008-07-05 05:49:57 UTC (rev 4244)
@@ -37,7 +37,9 @@
public class MapArchObjectTest {
/**
- * Test for {@link MapArchObject#parseMapArch(java.io.BufferedReader)}.
+ * Test for {@link
+ * net.sf.gridarta.io.AbstractMapArchObjectParser#load(BufferedReader,
+ * net.sf.gridarta.map.MapArchObject)}.
* @throws IOException (unexpected)
*/
@Test
Modified: trunk/src/app/net/sf/gridarta/gameobject/ArchetypeParser.java
===================================================================
--- trunk/src/app/net/sf/gridarta/gameobject/ArchetypeParser.java 2008-07-05 05:29:45 UTC (rev 4243)
+++ trunk/src/app/net/sf/gridarta/gameobject/ArchetypeParser.java 2008-07-05 05:49:57 UTC (rev 4244)
@@ -75,7 +75,7 @@
/**
* Short form of {@link #parseArchetypeFromStream(BufferedReader,
- * GameObject, String, String, String, String, String)}.
+ * GameObject, String, String, String, String, String, List)}.
* @param in <code>BufferedReader</code> file stream of archetype data
* @param panelName the panel name to add the archetype to
* @param folderName the folder name to add the archetype to
Modified: trunk/src/app/net/sf/gridarta/gameobject/GameObject.java
===================================================================
--- trunk/src/app/net/sf/gridarta/gameobject/GameObject.java 2008-07-05 05:29:45 UTC (rev 4243)
+++ trunk/src/app/net/sf/gridarta/gameobject/GameObject.java 2008-07-05 05:49:57 UTC (rev 4244)
@@ -1504,7 +1504,7 @@
/**
* Add/remove a certain connection of the given arch by changing archtype
* and face.
- * @param gameObject GameObject to connect.
+ * @param archetype GameObject to connect.
* @param archetype the archetype to connect with
*/
public void connectArch(@NotNull final R archetype) {
Modified: trunk/src/app/net/sf/gridarta/gui/ErrorListView.java
===================================================================
--- trunk/src/app/net/sf/gridarta/gui/ErrorListView.java 2008-07-05 05:29:45 UTC (rev 4243)
+++ trunk/src/app/net/sf/gridarta/gui/ErrorListView.java 2008-07-05 05:49:57 UTC (rev 4244)
@@ -137,7 +137,7 @@
/**
* Create a ConnectionPanel.
- * @param mapControl the map manager
+ * @param mapManager the map manager
* @param selectedSquareView the selected square view to update
*/
public ErrorListView(@NotNull final MapManager<G, A, R, V> mapManager, @NotNull final SelectedSquareView<G, A, R, V> selectedSquareView) {
Modified: trunk/src/app/net/sf/gridarta/gui/findarchetypes/TableModel.java
===================================================================
--- trunk/src/app/net/sf/gridarta/gui/findarchetypes/TableModel.java 2008-07-05 05:29:45 UTC (rev 4243)
+++ trunk/src/app/net/sf/gridarta/gui/findarchetypes/TableModel.java 2008-07-05 05:49:57 UTC (rev 4244)
@@ -175,8 +175,9 @@
/**
* Finish updating the model's contents. This function must be called after
- * one or more elements have been added with {@link #add(R)}. If at least
- * one element has been added, {@link #sortTable()} must be called first.
+ * one or more elements have been added with {@link #add(Archetype)}. If at
+ * least one element has been added, {@link #sortTable()} must be called
+ * first.
*/
public void finishUpdate() {
if (sorting == null && archetypes.size() > 0) {
Modified: trunk/src/app/net/sf/gridarta/gui/map/MapViewBasic.java
===================================================================
--- trunk/src/app/net/sf/gridarta/gui/map/MapViewBasic.java 2008-07-05 05:29:45 UTC (rev 4243)
+++ trunk/src/app/net/sf/gridarta/gui/map/MapViewBasic.java 2008-07-05 05:49:57 UTC (rev 4244)
@@ -161,7 +161,6 @@
/**
* Get the cursor square.
* @return cursor square or <code>null</code> if no current cursor
- * @see #getCursorPosition()
*/
@Nullable
public MapSquare<G, A, R> getCursorSquare() {
@@ -191,7 +190,7 @@
/**
* Set the cursor position.
* @param cursorPosition cursor position
- * @see #getCursorPosition()
+ * @see #getCursorSquare()
*/
public void setCursorPosition(final Point cursorPosition) {
mapCursor.setLocation(cursorPosition);
Modified: trunk/src/app/net/sf/gridarta/gui/pickmapchooser/Loader.java
===================================================================
--- trunk/src/app/net/sf/gridarta/gui/pickmapchooser/Loader.java 2008-07-05 05:29:45 UTC (rev 4243)
+++ trunk/src/app/net/sf/gridarta/gui/pickmapchooser/Loader.java 2008-07-05 05:49:57 UTC (rev 4244)
@@ -71,7 +71,6 @@
/**
* Loads all pickmap files from a directory and its subdirectories.
- * @param dir the directory
* @param parent the parent folder, or <code>null</code>
* @param folderName the folder name of <code>dir</code>
* @return the default <code>Folder</code>, or <code>null</code> if this
Modified: trunk/src/app/net/sf/gridarta/gui/pickmapchooser/PickmapChooserControl.java
===================================================================
--- trunk/src/app/net/sf/gridarta/gui/pickmapchooser/PickmapChooserControl.java 2008-07-05 05:29:45 UTC (rev 4243)
+++ trunk/src/app/net/sf/gridarta/gui/pickmapchooser/PickmapChooserControl.java 2008-07-05 05:49:57 UTC (rev 4244)
@@ -177,7 +177,7 @@
/**
* Reload a pickmap. Does nothing if the given file is unknown.
- * @param mapFile The file of the pickmap.
+ * @param file The file of the pickmap.
*/
public void reloadPickmap(@NotNull final File file) {
final Pickmap<G, A, R, V> pickmap = view.getPickmap(file);
Modified: trunk/src/app/net/sf/gridarta/io/AbstractGameObjectParser.java
===================================================================
--- trunk/src/app/net/sf/gridarta/io/AbstractGameObjectParser.java 2008-07-05 05:29:45 UTC (rev 4243)
+++ trunk/src/app/net/sf/gridarta/io/AbstractGameObjectParser.java 2008-07-05 05:49:57 UTC (rev 4244)
@@ -38,8 +38,8 @@
/**
* Abstract base class for classes implementing {@link GameObjectParser}s. This
* class contains the common code for reading game objects. Subclasses can
- * extend the parser ({@link #parseLine(String, A)}. No support for writing is
- * present.
+ * extend the parser ({@link #parseLine(String, GameObject)}. No support for
+ * writing is present.
* @author Andreas Kirschbaum
*/
public abstract class AbstractGameObjectParser<G extends GameObject<G, A, R>, A extends MapArchObject<A>, R extends Archetype<G, A, R>> implements GameObjectParser<G, A, R> {
Modified: trunk/src/app/net/sf/gridarta/io/AbstractMapArchObjectParser.java
===================================================================
--- trunk/src/app/net/sf/gridarta/io/AbstractMapArchObjectParser.java 2008-07-05 05:29:45 UTC (rev 4243)
+++ trunk/src/app/net/sf/gridarta/io/AbstractMapArchObjectParser.java 2008-07-05 05:49:57 UTC (rev 4244)
@@ -28,8 +28,8 @@
/**
* Abstract base class for classes implementing {@link MapArchObjectParser}s.
* This class contains the common code for reading map arch objects. Subclasses
- * can extend the parser ({@link #parseLine(String, A)}. No support for writing
- * is present.
+ * can extend the parser ({@link #parseLine(String, MapArchObject)}. No support
+ * for writing is present.
* @author Andreas Kirschbaum
*/
public abstract class AbstractMapArchObjectParser<A extends MapArchObject<A>> implements MapArchObjectParser<A> {
Modified: trunk/src/app/net/sf/gridarta/map/validation/checks/UndefinedArchetypeError.java
===================================================================
--- trunk/src/app/net/sf/gridarta/map/validation/checks/UndefinedArchetypeError.java 2008-07-05 05:29:45 UTC (rev 4243)
+++ trunk/src/app/net/sf/gridarta/map/validation/checks/UndefinedArchetypeError.java 2008-07-05 05:49:57 UTC (rev 4244)
@@ -25,7 +25,7 @@
import net.sf.gridarta.map.validation.GameObjectValidationError;
/**
- * Validation error that's used when the {@link UndefinedArchetypeCheker}
+ * Validation error that's used when the {@link UndefinedArchetypeChecker}
* detected a possible error on the map.
* @author Andreas Kirschbaum
*/
Modified: trunk/src/app/net/sf/gridarta/textedit/textarea/tokenmarker/KeywordMap.java
===================================================================
--- trunk/src/app/net/sf/gridarta/textedit/textarea/tokenmarker/KeywordMap.java 2008-07-05 05:29:45 UTC (rev 4243)
+++ trunk/src/app/net/sf/gridarta/textedit/textarea/tokenmarker/KeywordMap.java 2008-07-05 05:49:57 UTC (rev 4244)
@@ -69,8 +69,7 @@
}
/**
- * Adds a key-value mapping. All characters in the key must be withing
- * {@link #Node.MIN}..{@link #Node.MAX}.
+ * Adds a key-value mapping.
* @param keyword The key to add.
* @param id The value to map to.
*/
Modified: trunk/src/app/net/sf/gridarta/textedit/textarea/tokenmarker/TokenMarkerFactory.java
===================================================================
--- trunk/src/app/net/sf/gridarta/textedit/textarea/tokenmarker/TokenMarkerFactory.java 2008-07-05 05:29:45 UTC (rev 4243)
+++ trunk/src/app/net/sf/gridarta/textedit/textarea/tokenmarker/TokenMarkerFactory.java 2008-07-05 05:49:57 UTC (rev 4244)
@@ -32,10 +32,10 @@
*/
public class TokenMarkerFactory {
- /** File extension for {@link CrossfireDialogTokenMarkerTokenMarker}. */
+ /** File extension for {@link CrossfireDialogTokenMarker}. */
public static final String CROSSFIRE_DIALOG = "crossfire-dialog";
- /** File extension for {@link DaimoninAITokenMarkerTokenMarkerFactory}. */
+ /** File extension for {@link DaimoninAITokenMarker}. */
public static final String DAIMONIN_AI = "daimonin-ai";
/** Maps file extensions to token marker classes. */
Modified: trunk/src/app/net/sf/gridarta/treasurelist/TreasureLoader.java
===================================================================
--- trunk/src/app/net/sf/gridarta/treasurelist/TreasureLoader.java 2008-07-05 05:29:45 UTC (rev 4243)
+++ trunk/src/app/net/sf/gridarta/treasurelist/TreasureLoader.java 2008-07-05 05:49:57 UTC (rev 4244)
@@ -158,7 +158,7 @@
* <code>dname</code>
* @param tmpList tmp. container for all treasurelists
* @param needLink all sub-treasurelist nodes that need linking
- * @see #parseTreasures()
+ * @see #parseTreasures(TreasureLocation[], Map, DefaultMutableTreeNode)
*/
private void loadTreasureList(final String dname, final String fname, final List<TreasureTreeNode> tmpList, final List<TreasureTreeNode> needLink) {
if (fname == null) {
This was sent by the SourceForge.net collaborative development platform, the world's largest Open Source development site.
|
