RED

refs 2255

org.fortiss.tooling.base/trunk/src/org/fortiss/tooling/base/annotation/valueprovider/IAnnotationValueProvider.java

@@ -36,10 +36,10 @@ import org.fortiss.tooling.kernel.service.base.IEObjectAware;
  * </p>
  * 
  * <p>
- * The interface / some of its methods take two template parameters
+ * The interface / some of its methods take two template parameters:
  * 
  * <ul>
- * <li><tt>T</tt>: Meta-model type of the specification, i.e. the particular subclass of
+ * <li><tt>T</tt>: Meta-model type of the specification, i.e., the particular subclass of
  * {@link IAnnotatedSpecification} supported by the respective implementation of this
  * {@link IAnnotationValueProvider} interface.</li>
  * <li><tt>U</tt>: Data type used in the UI to support the respective annotation. For <tt>U</tt>, a
@@ -81,6 +81,10 @@ public interface IAnnotationValueProvider<T extends IAnnotatedSpecification> ext
 	public <U> U getAnnotationValue(T specification) throws Exception;
 
 	/**
+	 * TODO(VA) Probably obvious for somebody who knows already how to deal with annotations but not
+	 * for a newcomer, so take this remark into account only if you think it's valuable: what is a
+	 * multi-instance annotation?
+	 * 
 	 * Returns the value of a multi-instance annotation's instance denoted by {@code instanceKey}.
 	 */
 	public <U> U getAnnotationValue(T specification, String instanceKey) throws Exception;