some review comments + ratings

f373a4b4 · Daniel Ratiu · b10e799f · f373a4b4 · f373a4b4 · f373a4b4
Commit f373a4b4 authored 13 years ago by Daniel Ratiu
--- 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

--- 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$

--- 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$

--- 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$

--- 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$

--- 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$

--- 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>
--- 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 {


--- 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 {