Changeset 1217 for trunk/autoquest-core-usability-evaluation/src/main/java/de/ugoe/cs/autoquest/usability/rules/UsabilityMetric.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/UsabilityMetric.java (modified) (2 diffs)

trunk/autoquest-core-usability-evaluation/src/main/java/de/ugoe/cs/autoquest/usability/rules/UsabilityMetric.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
+ * Interface for usability metrics. A metric is a way of measuring or evaluating a particular
+ * phenomenon or thing, in this case usability.
  * </p>
  * 
@@ -27 +28 @@
  */
 public interface UsabilityMetric {
-    
-    public Optional<UsabilityDefect> calculate();
+
+    /**
+     * 
+     * <p>
+     * Calculates the metric.
+     * </p>
+     * 
+     * @return Detailed description of the usability problem, if calculated metric exceeds defined
+     *         threshold.
+     */
+    public Optional<UsabilityProblemDescription> calculate();
 
 }