From f373a4b4ad7d5faf6adfd58a6c3d7150f99ad627 Mon Sep 17 00:00:00 2001
From: Daniel Ratiu <ratiu@fortiss.org>
Date: Mon, 27 Jun 2011 15:58:52 +0000
Subject: [PATCH] some review comments + ratings
---
.../tooling/kernel/interfaces/ICompositionContext.java | 4 +++-
.../org/fortiss/tooling/kernel/interfaces/ICompositor.java | 2 ++
.../fortiss/tooling/kernel/interfaces/IConnectionContext.java | 2 ++
.../src/org/fortiss/tooling/kernel/interfaces/IConnector.java | 2 ++
.../org/fortiss/tooling/kernel/interfaces/IEObjectAware.java | 2 ++
.../interfaces/IEclipseResourceStorageLocationProvider.java | 2 ++
.../src/org/fortiss/tooling/kernel/internal/package.html | 2 ++
.../org/fortiss/tooling/kernel/util/ExtensionPointUtils.java | 2 +-
.../src/org/fortiss/tooling/kernel/util/LoggingUtils.java | 2 +-
9 files changed, 17 insertions(+), 3 deletions(-)
diff --git a/org.fortiss.tooling.kernel/trunk/src/org/fortiss/tooling/kernel/interfaces/ICompositionContext.java b/org.fortiss.tooling.kernel/trunk/src/org/fortiss/tooling/kernel/interfaces/ICompositionContext.java
index c34ab99ee..18becd197 100644
--- a/org.fortiss.tooling.kernel/trunk/src/org/fortiss/tooling/kernel/interfaces/ICompositionContext.java
+++ b/org.fortiss.tooling.kernel/trunk/src/org/fortiss/tooling/kernel/interfaces/ICompositionContext.java
@@ -22,10 +22,12 @@ package org.fortiss.tooling.kernel.interfaces;
* An {@link ICompositionContext} provides additional information like drop
* point positions to an {@link ICompositor}.
*
+ * @FloH: what is a "drop point" position?
+ *
* @author hoelzl
* @author $Author$
* @version $Rev$
- * @ConQAT.Rating YELLOW Hash: 28A6F3DD88525F3501E5C92139AC9265
+ * @ConQAT.Rating RED Hash: D85BD49FE3F70C2C4AF5B5B9250C0863
*/
public interface ICompositionContext {
// this is just a marker interface
diff --git a/org.fortiss.tooling.kernel/trunk/src/org/fortiss/tooling/kernel/interfaces/ICompositor.java b/org.fortiss.tooling.kernel/trunk/src/org/fortiss/tooling/kernel/interfaces/ICompositor.java
index d2419075a..09000d1cf 100644
--- a/org.fortiss.tooling.kernel/trunk/src/org/fortiss/tooling/kernel/interfaces/ICompositor.java
+++ b/org.fortiss.tooling.kernel/trunk/src/org/fortiss/tooling/kernel/interfaces/ICompositor.java
@@ -24,6 +24,8 @@ import org.fortiss.tooling.kernel.services.IPrototypeService.Prototype;
* Interface for compositors, i.e. classes which know how to compose
* {@link EObject}s.
*
+ * @TODO: rename to "ElementCompositor"
+ *
* @author hoelzl
* @author $Author$
* @version $Rev$
diff --git a/org.fortiss.tooling.kernel/trunk/src/org/fortiss/tooling/kernel/interfaces/IConnectionContext.java b/org.fortiss.tooling.kernel/trunk/src/org/fortiss/tooling/kernel/interfaces/IConnectionContext.java
index 31f30d529..2307ca601 100644
--- a/org.fortiss.tooling.kernel/trunk/src/org/fortiss/tooling/kernel/interfaces/IConnectionContext.java
+++ b/org.fortiss.tooling.kernel/trunk/src/org/fortiss/tooling/kernel/interfaces/IConnectionContext.java
@@ -22,6 +22,8 @@ package org.fortiss.tooling.kernel.interfaces;
* An {@link IConnectionContext} provides additional information like drag point
* positions to an {@link IConnector}.
*
+ * @FloH: what is a "drag point position"?
+ *
* @author hoelzl
* @author $Author$
* @version $Rev$
diff --git a/org.fortiss.tooling.kernel/trunk/src/org/fortiss/tooling/kernel/interfaces/IConnector.java b/org.fortiss.tooling.kernel/trunk/src/org/fortiss/tooling/kernel/interfaces/IConnector.java
index dd3c31b01..bd85c2325 100644
--- a/org.fortiss.tooling.kernel/trunk/src/org/fortiss/tooling/kernel/interfaces/IConnector.java
+++ b/org.fortiss.tooling.kernel/trunk/src/org/fortiss/tooling/kernel/interfaces/IConnector.java
@@ -23,6 +23,8 @@ import org.eclipse.emf.ecore.EObject;
* Interface for connectors, i.e. classes which connect model elements. This may
* either be a direct connection or by using an additional connection element.
*
+ * @TODO: rename to "ConnectionCompositor" + make the parent explicit
+ *
* @author hoelzl
* @author $Author$
* @version $Rev$
diff --git a/org.fortiss.tooling.kernel/trunk/src/org/fortiss/tooling/kernel/interfaces/IEObjectAware.java b/org.fortiss.tooling.kernel/trunk/src/org/fortiss/tooling/kernel/interfaces/IEObjectAware.java
index 88b195f70..d791a80ce 100644
--- a/org.fortiss.tooling.kernel/trunk/src/org/fortiss/tooling/kernel/interfaces/IEObjectAware.java
+++ b/org.fortiss.tooling.kernel/trunk/src/org/fortiss/tooling/kernel/interfaces/IEObjectAware.java
@@ -23,6 +23,8 @@ import org.fortiss.tooling.kernel.base.EObjectAwareServiceBase;
/**
* Abstract interface for {@link EObjectAwareServiceBase} base implementation.
*
+ * @TODO: a typical use is ...
+ *
* @author hoelzl
* @author $Author$
* @version $Rev$
diff --git a/org.fortiss.tooling.kernel/trunk/src/org/fortiss/tooling/kernel/interfaces/IEclipseResourceStorageLocationProvider.java b/org.fortiss.tooling.kernel/trunk/src/org/fortiss/tooling/kernel/interfaces/IEclipseResourceStorageLocationProvider.java
index 80a8d0283..d28997a32 100644
--- a/org.fortiss.tooling.kernel/trunk/src/org/fortiss/tooling/kernel/interfaces/IEclipseResourceStorageLocationProvider.java
+++ b/org.fortiss.tooling.kernel/trunk/src/org/fortiss/tooling/kernel/interfaces/IEclipseResourceStorageLocationProvider.java
@@ -23,6 +23,8 @@ import org.fortiss.tooling.kernel.internal.storage.eclipse.EclipseResourceStorag
/**
* Extension interface for the {@link EclipseResourceStorageProvider} mechanism.
*
+ * @TODO: do we really need this interface?
+ *
* @author hoelzlf
* @author $Author$
* @version $Rev$
diff --git a/org.fortiss.tooling.kernel/trunk/src/org/fortiss/tooling/kernel/internal/package.html b/org.fortiss.tooling.kernel/trunk/src/org/fortiss/tooling/kernel/internal/package.html
index 885b26479..99c4e9e2d 100644
--- a/org.fortiss.tooling.kernel/trunk/src/org/fortiss/tooling/kernel/internal/package.html
+++ b/org.fortiss.tooling.kernel/trunk/src/org/fortiss/tooling/kernel/internal/package.html
@@ -5,4 +5,6 @@
-->
<body>
Implementations of the kernel services defined in the <code>kernel.services</code> package.
+<p>
+@TODO: shouldn't this package be named kernel.services.internal? + according to Eclipse naming, the internal packages should not be used by clients -- is this the case here? if not, the name 'internal' should be changed into 'impl'
</body>
diff --git a/org.fortiss.tooling.kernel/trunk/src/org/fortiss/tooling/kernel/util/ExtensionPointUtils.java b/org.fortiss.tooling.kernel/trunk/src/org/fortiss/tooling/kernel/util/ExtensionPointUtils.java
index 743dcf8a7..3198f6492 100644
--- a/org.fortiss.tooling.kernel/trunk/src/org/fortiss/tooling/kernel/util/ExtensionPointUtils.java
+++ b/org.fortiss.tooling.kernel/trunk/src/org/fortiss/tooling/kernel/util/ExtensionPointUtils.java
@@ -39,7 +39,7 @@ import org.osgi.framework.Bundle;
* @author hummel
* @author $Author$
* @version $Rev$
- * @ConQAT.Rating YELLOW Hash: 05174A663568D6A53F98A21704CDBCA5
+ * @ConQAT.Rating GREEN Hash: 9EFBA1C989BEFB70A825EC0F299A0B46
*/
public class ExtensionPointUtils {
diff --git a/org.fortiss.tooling.kernel/trunk/src/org/fortiss/tooling/kernel/util/LoggingUtils.java b/org.fortiss.tooling.kernel/trunk/src/org/fortiss/tooling/kernel/util/LoggingUtils.java
index 74fd46168..d096571b2 100644
--- a/org.fortiss.tooling.kernel/trunk/src/org/fortiss/tooling/kernel/util/LoggingUtils.java
+++ b/org.fortiss.tooling.kernel/trunk/src/org/fortiss/tooling/kernel/util/LoggingUtils.java
@@ -32,7 +32,7 @@ import org.eclipse.core.runtime.Status;
* @author schwitze
* @author $Author$
* @version $Rev$
- * @ConQAT.Rating YELLOW Hash: 27FE1FF60B7FF5F94B1619BE297E4036
+ * @ConQAT.Rating GREEN Hash: 5489A04000105CF881046928C19E6E14
*/
public class LoggingUtils {
--
GitLab