Changeset 1217 for trunk/autoquest-core-usability-evaluation/src/main/java/de/ugoe/cs/autoquest/usability/rules/UsabilityUsageProblem.java

Timestamp:

06/06/13 17:08:25 (11 years ago)

Author:

adeicke

Message:

• Added proper formating and JavaDoc?.
• Several renaming refactorings.

File:

• trunk/autoquest-core-usability-evaluation/src/main/java/de/ugoe/cs/autoquest/usability/rules/UsabilityUsageProblem.java (moved) (moved from trunk/autoquest-core-usability-evaluation/src/main/java/de/ugoe/cs/autoquest/usability/rules/UsabilityUsageDefect.java) (1 diff)

trunk/autoquest-core-usability-evaluation/src/main/java/de/ugoe/cs/autoquest/usability/rules/UsabilityUsageProblem.java

@@ -17 +17 @@
 import com.google.common.base.Optional;
 
-import de.ugoe.cs.autoquest.usability.result.UsabilityDefect;
+import de.ugoe.cs.autoquest.usability.result.UsabilityProblemDescription;
 
 /**
  * <p>
- * TODO comment
+ * Common interface for usability problems. Simple speaking, a usability problem is a specific
+ * problem that negatively affects the usage of a application.
  * </p>
  * 
  * @author Alexander Deicke
  */
-public interface UsabilityUsageDefect {
-    
-    public Optional<UsabilityDefect> check();
+public interface UsabilityUsageProblem {
+
+    /**
+     * 
+     * <p>
+     * Checks, if usability problem is present.
+     * </p>
+     * 
+     * @return Detailed description of the usability problem, if it was detected.
+     */
+    public Optional<UsabilityProblemDescription> check();
 
 }