From 36800c808ff22cf891b7e6e7589c4884c5759e1d Mon Sep 17 00:00:00 2001
From: Simon Barner <barner@fortiss.org>
Date: Thu, 10 Mar 2016 13:33:20 +0000
Subject: [PATCH] - Fix comments
---
.../editingsupport/EditingSupportFactory.java | 18 +++++++++++++++---
.../labelprovider/AnnotationLabelProvider.java | 5 ++++-
.../labelprovider/LabelProviderFactory.java | 6 +++++-
.../generic/filter/AnnotationFilterWidget.java | 3 +++
4 files changed, 27 insertions(+), 5 deletions(-)
diff --git a/org.fortiss.tooling.base.ui/trunk/src/org/fortiss/tooling/base/ui/annotation/editingsupport/EditingSupportFactory.java b/org.fortiss.tooling.base.ui/trunk/src/org/fortiss/tooling/base/ui/annotation/editingsupport/EditingSupportFactory.java
index a3617aa06..24eead569 100644
--- a/org.fortiss.tooling.base.ui/trunk/src/org/fortiss/tooling/base/ui/annotation/editingsupport/EditingSupportFactory.java
+++ b/org.fortiss.tooling.base.ui/trunk/src/org/fortiss/tooling/base/ui/annotation/editingsupport/EditingSupportFactory.java
@@ -51,7 +51,7 @@ import org.fortiss.tooling.kernel.utils.EcoreUtils;
* @author barner
* @author $Author$
* @version $Rev$
- * @ConQAT.Rating GREEN Hash: B91572CD4058C6916E2343554AAD2F8E
+ * @ConQAT.Rating GREEN Hash: F406176F532AFCB05E651802C16E516B
*/
public class EditingSupportFactory {
@@ -87,6 +87,8 @@ public class EditingSupportFactory {
* Annotation instance
* @param instanceKey
* Key identifying annotation instance
+ *
+ * @return {@link EditingSupport} for annotations that can be instantiated dynamically.
*/
private static
<T extends IAnnotatedSpecification, V extends DynamicInstanceAnnotationValueProviderBase<T>>
@@ -112,6 +114,9 @@ public class EditingSupportFactory {
* Annotation instance
* @param instanceKey
* Key identifying annotation instance
+ *
+ * @return {@link EditingSupport} that is directly based on
+ * {@link EStructuralFeatureValueProviderBase}.
*/
private static
<T extends IAnnotatedSpecification, V extends EStructuralFeatureValueProviderBase<T>>
@@ -123,11 +128,11 @@ public class EditingSupportFactory {
EStructuralFeature structuralFeature =
valueProvider.getEStructuralFeature(specification, instanceKey);
- EClassifier eType = null;
+ EClassifier eType;
try {
eType = structuralFeature.getEType();
} catch(Exception e) {
- // Ignore
+ eType = null;
}
if(structuralFeature.getUpperBound() == 0) {
@@ -227,6 +232,9 @@ public class EditingSupportFactory {
* Annotation instance
* @param instanceKey
* Key identifying annotation instance
+ *
+ * @return {@link EditingSupport} for value providers that are directly based on
+ * {@link ValueProviderBase}.
*/
private static <T extends IAnnotatedSpecification, V extends ValueProviderBase<T>>
EditingSupport createEditingSupport4ValueProviderBase(V valueProvider,
@@ -275,6 +283,8 @@ public class EditingSupportFactory {
* Annotation instance
* @param instanceKey
* Key identifying annotation instance
+ *
+ * @return {@link EditingSupport} for the given {@link IAnnotatedSpecification}.
*/
@SuppressWarnings({"rawtypes", "unchecked"})
public static <T extends IAnnotatedSpecification> EditingSupport createEditingSupport(
@@ -317,6 +327,8 @@ public class EditingSupportFactory {
* Annotation type
* @param specification
* Annotation instance
+ *
+ * @return {@link EditingSupport} without referring to the optional {@code instanceKey}.
*/
public static <T extends IAnnotatedSpecification> EditingSupport createEditingSupport(
IAnnotationValueProvider<T> valueProvider, ColumnViewer viewer,
diff --git a/org.fortiss.tooling.base.ui/trunk/src/org/fortiss/tooling/base/ui/annotation/labelprovider/AnnotationLabelProvider.java b/org.fortiss.tooling.base.ui/trunk/src/org/fortiss/tooling/base/ui/annotation/labelprovider/AnnotationLabelProvider.java
index 2f9b5ac56..615e29ec5 100644
--- a/org.fortiss.tooling.base.ui/trunk/src/org/fortiss/tooling/base/ui/annotation/labelprovider/AnnotationLabelProvider.java
+++ b/org.fortiss.tooling.base.ui/trunk/src/org/fortiss/tooling/base/ui/annotation/labelprovider/AnnotationLabelProvider.java
@@ -35,7 +35,7 @@ import org.fortiss.tooling.base.ui.annotation.view.IAnnotationViewPart;
* @author diewald, barner
* @author $Author$
* @version $Rev$
- * @ConQAT.Rating GREEN Hash: 38784CC83BF68AFCACF7E99385DEC1E9
+ * @ConQAT.Rating GREEN Hash: 30267710CF835FE32C75F8B08BFA6FCC
*/
public class AnnotationLabelProvider extends LabelProviderBase {
@@ -68,6 +68,9 @@ public class AnnotationLabelProvider extends LabelProviderBase {
* view required to retrieve the selected elements
* @param instanceKey
* Key identifying the annotation instance to be displayed.
+ * @param editingSupport
+ * {@link EditingSupport} of column for which the new {@link AnnotationLabelProvider}
+ * should provided the label.
*/
public AnnotationLabelProvider(Class<? extends IAnnotatedSpecification> clazz,
IAnnotationViewPart viewPart, String instanceKey, EditingSupport editingSupport) {
diff --git a/org.fortiss.tooling.base.ui/trunk/src/org/fortiss/tooling/base/ui/annotation/labelprovider/LabelProviderFactory.java b/org.fortiss.tooling.base.ui/trunk/src/org/fortiss/tooling/base/ui/annotation/labelprovider/LabelProviderFactory.java
index 4cefd4e15..a9cc42359 100644
--- a/org.fortiss.tooling.base.ui/trunk/src/org/fortiss/tooling/base/ui/annotation/labelprovider/LabelProviderFactory.java
+++ b/org.fortiss.tooling.base.ui/trunk/src/org/fortiss/tooling/base/ui/annotation/labelprovider/LabelProviderFactory.java
@@ -32,7 +32,7 @@ import org.fortiss.tooling.base.ui.annotation.view.generic.GenericAnnotationView
* @author barner
* @author $Author$
* @version $Rev$
- * @ConQAT.Rating GREEN Hash: 1896D4425862EBAFB14A796212541104
+ * @ConQAT.Rating GREEN Hash: BA975FC0E3ECD78ED2D3FC42B64CB7BA
*/
public class LabelProviderFactory {
@@ -53,6 +53,8 @@ public class LabelProviderFactory {
* Annotation instance
* @param instanceKey
* Key identifying annotation instance
+ *
+ * @return {@link ColumnLabelProvider} for the given {@link IAnnotatedSpecification}.
*/
public static <T extends IAnnotatedSpecification> ColumnLabelProvider createLabelProvider(
IAnnotationValueProvider<T> valueProvider, IAnnotationViewPart viewPart,
@@ -85,6 +87,8 @@ public class LabelProviderFactory {
* Annotation type
* @param specification
* Annotation instance
+ *
+ * @return {@link ColumnLabelProvider} for the given {@link IAnnotatedSpecification}.
*/
public static <T extends IAnnotatedSpecification> ColumnLabelProvider createLabelProvider(
IAnnotationValueProvider<T> valueProvider, IAnnotationViewPart viewPart,
diff --git a/org.fortiss.tooling.base.ui/trunk/src/org/fortiss/tooling/base/ui/annotation/view/generic/filter/AnnotationFilterWidget.java b/org.fortiss.tooling.base.ui/trunk/src/org/fortiss/tooling/base/ui/annotation/view/generic/filter/AnnotationFilterWidget.java
index df97d3060..6a46a4971 100644
--- a/org.fortiss.tooling.base.ui/trunk/src/org/fortiss/tooling/base/ui/annotation/view/generic/filter/AnnotationFilterWidget.java
+++ b/org.fortiss.tooling.base.ui/trunk/src/org/fortiss/tooling/base/ui/annotation/view/generic/filter/AnnotationFilterWidget.java
@@ -223,6 +223,9 @@ public class AnnotationFilterWidget extends Composite {
* {@link Composite} to which button should be added
* @param view
* {@link GenericAnnotationView} to be filtered.
+ *
+ * @return {@link Button} for setting the options for filtering the
+ * {@link GenericAnnotationView} for the currently selected model element type.
*/
private Button createModelElementTypeFilterOptionsCheckButton(Composite parent,
final GenericAnnotationView view) {
--
GitLab