Changeset 849 for trunk/quest-plugin-mfc/src/main

Timestamp:

09/21/12 14:21:00 (12 years ago)

Author:

sherbold

Message:

• fixed a couple of JavaDoc? warnings

Location:

trunk/quest-plugin-mfc/src/main/java/de/ugoe/cs/quest/plugin/mfc

Files:

• EventGenerator.java (modified) (2 diffs)
• eventcore/ReplayWindowsMessage.java (modified) (2 diffs)
• eventcore/WindowsMessage.java (modified) (2 diffs)

trunk/quest-plugin-mfc/src/main/java/de/ugoe/cs/quest/plugin/mfc/EventGenerator.java

@@ -31 +31 @@
 /**
  * <p>
- * Translates sequences of windows messages into {@link WindowsEvent}s that can be used by the
+ * Translates sequences of windows messages into {@link Event}s that can be used by the
  * QUEST core libraries.
  * </p>
@@ -124 +124 @@
     /**
      * <p>
-     * Tries to match the rules to the given sequence to generate an {@link WindowsEvent}.
+     * Tries to match the rules to the given sequence to generate an {@link Event}.
      * </p>
      * <p>

trunk/quest-plugin-mfc/src/main/java/de/ugoe/cs/quest/plugin/mfc/eventcore/ReplayWindowsMessage.java

@@ -48 +48 @@
     /**
      * <p>
-     * Constructor. Creates a new message with a given message type.
-     * </p>
-     * 
-     * @param type
-     *            type of the message
-     * @param currentMessageParameters 
-     * @param target 
+     * Constructor. Creates a new replay message with a given {@link WindowsMessage}.
+     * </p>
+     * 
+     * @param replayedMessage
+     *            message from which the replay is generated
      */
     public ReplayWindowsMessage(WindowsMessage replayedMessage)
@@ -84 +82 @@
     /**
      * <p>
-     * Two {@link ReplayWindowsMessage} are equal, if their {@link #type}, {@link #xmlWindowDescription},
+     * Two {@link ReplayWindowsMessage} are equal, if their {@link #type}, {@link #getTargetXML},
      * and {@link #params} are equal.
      * </p>

trunk/quest-plugin-mfc/src/main/java/de/ugoe/cs/quest/plugin/mfc/eventcore/WindowsMessage.java

@@ -72 +72 @@
     /**
      * <p>
-     * Constructor. Creates a new message with a given message type.
+     * Constructor. Creates a new message with a given message's type, target, and parameters.
      * </p>
      * 
      * @param type
      *            type of the message
-     * @param currentMessageParameters
      * @param target
+     *            target of the message
+     * @param messageParameters
+     *            parameters of the message
      */
     public WindowsMessage(WindowsMessageType type,
@@ -175 +177 @@
     /**
      * <p>
-     * Two {@link WindowsMessage} are equal, if their {@link #type}, {@link #xmlWindowDescription},
+     * Two {@link WindowsMessage} are equal, if their {@link #type}, {@link #getTargetXML},
      * and {@link #params} are equal.
      * </p>