Author: bleny Date: 2010-08-12 18:18:13 +0200 (Thu, 12 Aug 2010) New Revision: 955 Url: http://nuiton.org/repositories/revision/eugene/955 Log: a bit of javadoc about objectModel Modified: trunk/eugene/src/main/java/org/nuiton/eugene/models/object/ObjectModelClass.java trunk/eugene/src/main/java/org/nuiton/eugene/models/object/ObjectModelElement.java Modified: trunk/eugene/src/main/java/org/nuiton/eugene/models/object/ObjectModelClass.java =================================================================== --- trunk/eugene/src/main/java/org/nuiton/eugene/models/object/ObjectModelClass.java 2010-08-12 15:22:56 UTC (rev 954) +++ trunk/eugene/src/main/java/org/nuiton/eugene/models/object/ObjectModelClass.java 2010-08-12 16:18:13 UTC (rev 955) @@ -55,6 +55,7 @@ Collection<ObjectModelClassifier> getInnerClassifiers(); /** + * // FIXME 20100812 fix javadoc, what is a discrimator and what it is used for ? * Returns the discriminator for the given superclass. * * @param superclass super class to get discriminator Modified: trunk/eugene/src/main/java/org/nuiton/eugene/models/object/ObjectModelElement.java =================================================================== --- trunk/eugene/src/main/java/org/nuiton/eugene/models/object/ObjectModelElement.java 2010-08-12 15:22:56 UTC (rev 954) +++ trunk/eugene/src/main/java/org/nuiton/eugene/models/object/ObjectModelElement.java 2010-08-12 16:18:13 UTC (rev 955) @@ -62,8 +62,12 @@ String getDocumentation(); /** - * Returns the description associated with this element. + * The description of this element is the upper part of the element's + * documentation. * + * The other part of the document can be accessed with + * {@link #getSourceDocumentation()} + * * @return the description associated with this element. */ String getDescription();