Author: tchemit Date: 2011-01-21 18:22:03 +0100 (Fri, 21 Jan 2011) New Revision: 1031 Url: http://nuiton.org/repositories/revision/eugene/1031 Log: Evolution #1219: Add documentation for stereotype and tagvalue in the annotation Modified: trunk/eugene/src/main/java/org/nuiton/eugene/EugeneStereoTypes.java trunk/eugene/src/main/java/org/nuiton/eugene/EugeneTagValues.java trunk/eugene/src/main/java/org/nuiton/eugene/ModelPropertiesUtil.java trunk/maven-eugene-plugin/src/main/java/org/nuiton/eugene/plugin/AvailableDataMojo.java Modified: trunk/eugene/src/main/java/org/nuiton/eugene/EugeneStereoTypes.java =================================================================== --- trunk/eugene/src/main/java/org/nuiton/eugene/EugeneStereoTypes.java 2011-01-21 14:45:11 UTC (rev 1030) +++ trunk/eugene/src/main/java/org/nuiton/eugene/EugeneStereoTypes.java 2011-01-21 17:22:03 UTC (rev 1031) @@ -48,7 +48,8 @@ * @see JavaBeanTransformer * @see JavaGeneratorUtil#hasBeanStereotype(ObjectModelClassifier) */ - @StereotypeDefinition(target = ObjectModelClassifier.class) + @StereotypeDefinition(target = ObjectModelClassifier.class, + documentation = "To specify that a class is a JavaBean") String STEREOTYPE_BEAN = "bean"; /** @@ -56,7 +57,8 @@ * * @see GeneratorUtil#hasIndexedStereotype(ObjectModelAttribute) */ - @StereotypeDefinition(target = ObjectModelAttribute.class) + @StereotypeDefinition(target = ObjectModelAttribute.class, + documentation = "To specify that a attribute is indexed") String STEREOTYPE_INDEXED = "indexed"; /** @@ -65,7 +67,8 @@ * @see GeneratorUtil#hasOrderedStereotype(ObjectModelAttribute) * @since 2.3 */ - @StereotypeDefinition(target = ObjectModelAttribute.class) + @StereotypeDefinition(target = ObjectModelAttribute.class, + documentation = "To specify that a attribute is ordered") String STEREOTYPE_ORDERED = "ordered"; } Modified: trunk/eugene/src/main/java/org/nuiton/eugene/EugeneTagValues.java =================================================================== --- trunk/eugene/src/main/java/org/nuiton/eugene/EugeneTagValues.java 2011-01-21 14:45:11 UTC (rev 1030) +++ trunk/eugene/src/main/java/org/nuiton/eugene/EugeneTagValues.java 2011-01-21 17:22:03 UTC (rev 1031) @@ -32,6 +32,7 @@ import org.nuiton.eugene.models.object.ObjectModelReader; import static org.nuiton.eugene.ModelPropertiesUtil.TagValueDefinition; + /** * Defines all tag values managed by Eugene. * <p/> @@ -54,7 +55,8 @@ * @see ObjectModelReader#loadModelTagValue(ObjectModel, String, String) * @since 2.3 */ - @TagValueDefinition(target = {ObjectModel.class}) + @TagValueDefinition(target = {ObjectModel.class}, + documentation = "To set the version of the model.") String TAG_VERSION = "version"; /** @@ -67,7 +69,8 @@ * @see GeneratorUtil#getDocumentationTagValue(ObjectModelElement) * @since 2.5 */ - @TagValueDefinition(target = {ObjectModel.class, ObjectModelElement.class}) + @TagValueDefinition(target = {ObjectModel.class, ObjectModelElement.class}, + documentation = "Sets the documentation of a model or any of his elements") String TAG_DOCUMENTATION = "documentation"; /** @@ -79,7 +82,8 @@ * @see JavaGeneratorUtil#getConstantPrefixTagValue(ObjectModel, ObjectModelClassifier) * @since 2.3 */ - @TagValueDefinition(target = {ObjectModel.class, ObjectModelClassifier.class}) + @TagValueDefinition(target = {ObjectModel.class, ObjectModelClassifier.class}, + documentation = "Sets the prefix of any constant to be generated for the given class") String TAG_CONSTANT_PREFIX = "constantPrefix"; /** @@ -91,7 +95,8 @@ * @see JavaGeneratorUtil#getNoPCSTagValue(ObjectModel, ObjectModelClassifier) * @since 2.3 */ - @TagValueDefinition(target = {ObjectModel.class, ObjectModelClassifier.class}) + @TagValueDefinition(target = {ObjectModel.class, ObjectModelClassifier.class}, + documentation = "To specify to not generate any propertyChange code for a class or any class of a model") String TAG_NO_PCS = "noPCS"; /** @@ -102,6 +107,7 @@ * @see JavaGeneratorUtil#getI18nPrefixTagValue(ObjectModelElement, ObjectModel) * @since 2.3 */ - @TagValueDefinition(target = {ObjectModel.class, ObjectModelClassifier.class}) + @TagValueDefinition(target = {ObjectModel.class, ObjectModelClassifier.class}, + documentation = "Sets the i18n prefix to use on I18n keys generated") String TAG_I18N_PREFIX = "i18n"; } Modified: trunk/eugene/src/main/java/org/nuiton/eugene/ModelPropertiesUtil.java =================================================================== --- trunk/eugene/src/main/java/org/nuiton/eugene/ModelPropertiesUtil.java 2011-01-21 14:45:11 UTC (rev 1030) +++ trunk/eugene/src/main/java/org/nuiton/eugene/ModelPropertiesUtil.java 2011-01-21 17:22:03 UTC (rev 1031) @@ -178,6 +178,14 @@ * @return the array of target object model element which can accept the tag value. */ Class<?>[] target(); + + /** + * Obtain the english documentation of the stereotype. + * + * @return the documentation of the stereotype. + * @since 2.3.1 + */ + String documentation(); } /** @@ -205,6 +213,14 @@ * @return the array of target object model element which can accept the tag value. */ Class<?>[] target(); + + /** + * Obtain the english documentation of the tag value. + * + * @return the documentation of the tag value. + * @since 2.3.1 + */ + String documentation(); } /** Modified: trunk/maven-eugene-plugin/src/main/java/org/nuiton/eugene/plugin/AvailableDataMojo.java =================================================================== --- trunk/maven-eugene-plugin/src/main/java/org/nuiton/eugene/plugin/AvailableDataMojo.java 2011-01-21 14:45:11 UTC (rev 1030) +++ trunk/maven-eugene-plugin/src/main/java/org/nuiton/eugene/plugin/AvailableDataMojo.java 2011-01-21 17:22:03 UTC (rev 1031) @@ -251,7 +251,8 @@ buffer.append(name); buffer.append("] targets : '"); buffer.append(toString(value)); - buffer.append('\''); + buffer.append("\' : "); + buffer.append(((ModelPropertiesUtil.TagValueDefinition) value).documentation()); } }, stereotype { @@ -283,7 +284,8 @@ buffer.append(name); buffer.append("] targets : '"); buffer.append(toString(value)); - buffer.append('\''); + buffer.append("\' : "); + buffer.append(((ModelPropertiesUtil.StereotypeDefinition) value).documentation()); } };