Revision: 3579
Author: [email protected]
Date: Tue Jun 1 08:45:33 2010
Log: Added documentation to help understand the existing critics.
http://code.google.com/p/power-architect/source/detail?r=3579
Modified:
/trunk/src/main/java/ca/sqlpower/architect/ddl/critic/Critic.java
/trunk/src/main/java/ca/sqlpower/architect/ddl/critic/Criticism.java
=======================================
--- /trunk/src/main/java/ca/sqlpower/architect/ddl/critic/Critic.java Sat
May 30 11:58:02 2009
+++ /trunk/src/main/java/ca/sqlpower/architect/ddl/critic/Critic.java Tue
Jun 1 08:45:33 2010
@@ -21,6 +21,13 @@
import java.util.List;
+/**
+ * A critic is used by a {...@link Criticizer} to find mistakes in a project.
+ * The critic does the actual work of analyzing an object or structure of
+ * the project and highlights errors by creating {...@link Criticism}s.
+ *
+ * @param <S> The object type that will be analyzed to be criticized.
+ */
public interface Critic<S> {
public List<Criticism<S>> criticize(S subject);
=======================================
--- /trunk/src/main/java/ca/sqlpower/architect/ddl/critic/Criticism.java
Sat May 30 11:58:02 2009
+++ /trunk/src/main/java/ca/sqlpower/architect/ddl/critic/Criticism.java
Tue Jun 1 08:45:33 2010
@@ -22,6 +22,14 @@
import java.util.Arrays;
import java.util.List;
+/**
+ * If the enabled {...@link Critic}s in the system find problems with the
project
+ * it will create criticisms. The criticisms can be used by users to help
+ * understand errors in their model and do quick fixes for them as well.
+ *
+ * @param <S>
+ * The object type this criticism can be found on.
+ */
public class Criticism<S> {
private final S subject;
