documentation

refs 2444

org.fortiss.tooling.kernel.ui/trunk/src/org/fortiss/tooling/kernel/ui/extension/base/EReferencePropertySectionBase.java

@@ -42,19 +42,26 @@ import org.fortiss.tooling.kernel.service.IPersistencyService;
  * Base class for a property section that allows to set an {@link EReference} using a
  * {@link ComboViewer}.
  * 
+ * <code>I</code> is the type of the object from which you read/write the reference. Typically the
+ * container of the reference (not of the referenced object but of the reference itself!)
+ * 
+ * <code>R</code> is the type of the object being referred to.
+ * 
  * @author aravantinos, barner
  * @author $Author$
  * @version $Rev$
- * @ConQAT.Rating GREEN Hash: 59A3537CB5D94CE7FC8331799937DFF7
+ * @ConQAT.Rating YELLOW Hash: 063F1F9F6C9BD7956CE1021A16072DEB
  */
 
 public abstract class EReferencePropertySectionBase<I extends EObject, R extends EObject> extends
 		PropertySectionBase {
+
 	/** Combo for component references. */
 	private ComboViewer modelReferenceCombo;
 
 	/** {@link ComboViewer} label. */
 	private final String modelReferenceComboLabel;
+
 	/**
 	 * Flag to know whether the selection is made by the class or by the user.
 	 * Needed because a "selected" event is triggered in all cases and we do not want to register
@@ -72,7 +79,12 @@ public abstract class EReferencePropertySectionBase<I extends EObject, R extends
 	/** The edited object (updated in {@link #setSectionInput(Object)}). */
 	private I input = null;
 
-	/** Constructs a new {@link EReferencePropertySectionBase}. */
+	/**
+	 * Constructs a new {@link EReferencePropertySectionBase}.
+	 * 
+	 * @param modelReferenceComboLabel
+	 *            The label to be used in front of the combobox.
+	 */
 	public EReferencePropertySectionBase(final String modelReferenceComboLabel) {
 		this.modelReferenceComboLabel = modelReferenceComboLabel;
 	}