improves documentation

refs 2553

org.fortiss.tooling.kernel/trunk/src/org/fortiss/tooling/kernel/service/IConstraintVerificationService.java

@@ -15,7 +15,7 @@ import org.fortiss.tooling.kernel.model.constraints.IConstraintVerificationStatu
  * @author aravantinos
  * @author $Author$
  * @version $Rev$
- * @ConQAT.Rating YELLOW Hash: 2A9D63384E528F868E36205000DFD107
+ * @ConQAT.Rating YELLOW Hash: 23108C2D054148D1DADBF2C8BB8023A2
  */
 public interface IConstraintVerificationService {
 
@@ -23,15 +23,24 @@ public interface IConstraintVerificationService {
 	public static final IConstraintVerificationService INSTANCE =
 			new ConstraintVerificationService();
 
-	/** Verifies the given constraint. */
+	/**
+	 * @param constraint
+	 *            Verifies <code>constraint</code>. The framework always runs the verification in a
+	 *            command. Should not yield any "useless" change because verification should always
+	 *            update the constraint status and the checksums anyways.
+	 */
 	public void verify(IConstraint constraint);
 
-	/** True if the given constraint is up to date. */
+	/**
+	 * @param constraint
+	 * @return <code>true</code> if <code>constraint</code> is up to date.
+	 */
 	public boolean isUpToDate(IConstraint constraint);
 
 	/**
-	 * Returns a list of possible automatic fixes for the (constraint of the) given status.
-	 * A status should be candidate to fixing if it is anything but successful or outdated.
+	 * @param status
+	 * @return A list of possible automatic fixes for the (constraint of) <code>status</code>.
+	 *         A status should be candidate to fixing if it is anything but successful or outdated.
 	 */
 	public List<IFix> fixes(IConstraintVerificationStatus status);