Revision: 3595
Author: [email protected]
Date: Wed Jun 9 12:02:33 2010
Log: Improved documentation on the constructor.
http://code.google.com/p/power-architect/source/detail?r=3595
Modified:
/trunk/src/main/java/ca/sqlpower/architect/ddl/critic/CriticAndSettings.java
=======================================
---
/trunk/src/main/java/ca/sqlpower/architect/ddl/critic/CriticAndSettings.java
Wed Jun 9 10:53:53 2010
+++
/trunk/src/main/java/ca/sqlpower/architect/ddl/critic/CriticAndSettings.java
Wed Jun 9 12:02:33 2010
@@ -78,7 +78,16 @@
* is normally from {...@link StarterPlatformTypes}.
*/
private final String platformType;
-
+
+ /**
+ * @param platformType
+ * A string that will group critics together. This is
normally a
+ * platform type name and can come from one of the
+ * {...@link StarterPlatformTypes}.
+ * @param name
+ * A short name of the critic. Should give the user an idea
of
+ * what the critic will warn the user about.
+ */
@Constructor
public CriticAndSettings(
@ConstructorParameter(propertyName="platformType") String
platformType,
