Last polishing in the code (comments basically and docs)

SOM-Research · Sep 1, 2015 · 4aff97f · 4aff97f
1 parent 3f962fb
commit 4aff97f
Show file tree

Hide file tree

Showing 25 changed files with 52 additions and 20 deletions.
diff --git a/jsondiscoverer.examples/src/jsondiscoverer/util/ExampleCoreographyBuilder.java b/jsondiscoverer.examples/src/jsondiscoverer/util/ExampleCoreographyBuilder.java
@@ -1,3 +1,15 @@
+/*******************************************************************************
+ * Copyright (c) 2008, 2015
+ * All rights reserved. This program and the accompanying materials
+ * are made available under the terms of the Eclipse Public License v1.0
+ * which accompanies this distribution, and is available at
+ * http://www.eclipse.org/legal/epl-v10.html
+ *
+ * Contributors:
+ *    Javier Canovas ([email protected]) 
+ *******************************************************************************/
+
+
 package jsondiscoverer.util;
 
 import java.io.File;

diff --git a/jsondiscoverer.web/src/jsondiscoverer/web/AbstractJsonDiscoverer.java b/jsondiscoverer.web/src/jsondiscoverer/web/AbstractJsonDiscoverer.java
@@ -45,7 +45,6 @@
  * Abstract class to factor some common behavior
  * 
  * @author Javier Canovas ([email protected])
- * @version 2.0.0
  *
  */
 public abstract class AbstractJsonDiscoverer extends HttpServlet {

diff --git a/jsondiscoverer.web/src/jsondiscoverer/web/JsonAdvancedDiscovererServlet.java b/jsondiscoverer.web/src/jsondiscoverer/web/JsonAdvancedDiscovererServlet.java
@@ -40,7 +40,6 @@
  * Main servlet to provide access to {@link JsonAdvancedDiscoverer}
  * 
  * @author Javier Canovas ([email protected])
- * @version 2.0.0
  *
  */
 @WebServlet("/advancedDiscover")

diff --git a/jsondiscoverer.web/src/jsondiscoverer/web/JsonComposerServlet.java b/jsondiscoverer.web/src/jsondiscoverer/web/JsonComposerServlet.java
@@ -39,7 +39,6 @@
  * ervlet to access to {@link JsonComposer}
  * 
  * @author Javier Canovas ([email protected])
- * @version 2.0.0
  *
  */
 @WebServlet("/composer")

diff --git a/jsondiscoverer.web/src/jsondiscoverer/web/JsonInjectorServlet.java b/jsondiscoverer.web/src/jsondiscoverer/web/JsonInjectorServlet.java
@@ -33,7 +33,6 @@
  * This servlet gives access to the {@link JsonInjector}
  * 
  * @author Javier Canovas ([email protected])
- * @version 2.0.0
  *
  */
 @WebServlet("/simpleDiscoverModel")

diff --git a/jsondiscoverer.web/src/jsondiscoverer/web/JsonPathCalculatorServlet.java b/jsondiscoverer.web/src/jsondiscoverer/web/JsonPathCalculatorServlet.java
@@ -34,7 +34,6 @@
  * This servlet allows calculating paths between nodes of the discovered metamodel
  * 
  * @author Javier Canovas ([email protected])
- * @version 2.0.0
  *
  */
 @WebServlet("/calculatePath")

diff --git a/jsondiscoverer.web/src/jsondiscoverer/web/JsonSimpleDiscovererServlet.java b/jsondiscoverer.web/src/jsondiscoverer/web/JsonSimpleDiscovererServlet.java
@@ -35,7 +35,6 @@
  * Main class that provides the main access to {@link JsonSimpleDiscoverer}
  * 
  * @author Javier Canovas ([email protected])
- * @version 2.0.0
  *
  */
 @WebServlet("/simpleDiscoverMetamodel")

diff --git a/jsondiscoverer.web/src/jsondiscoverer/web/ProxyServlet.java b/jsondiscoverer.web/src/jsondiscoverer/web/ProxyServlet.java
@@ -31,7 +31,6 @@
  * LIMIT_LINES to avoid overloading the server.
  * 
  * @author Javier Canovas ([email protected])
- * @version 2.0.0
  *
  */
 @WebServlet("/getJson")

diff --git a/jsondiscoverer.web/src/jsondiscoverer/web/StatusServlet.java b/jsondiscoverer.web/src/jsondiscoverer/web/StatusServlet.java
@@ -25,7 +25,6 @@
  * Simple servlet to know the versions of the other servlets
  * 
  * @author Javier Canovas ([email protected])
- * @version 2.0.0
  *
  */
 @WebServlet("/status")

diff --git a/jsondiscoverer.web/src/jsondiscoverer/web/VersionServlet.java b/jsondiscoverer.web/src/jsondiscoverer/web/VersionServlet.java
@@ -14,7 +14,6 @@
  * Super simple servlet to know the versio running in the server
  * 
  * @author Javier Canovas ([email protected])
- * @version 2.0.0
  *
  */
 @WebServlet("/version")

diff --git a/jsondiscoverer.zoo/src/jsondiscoverer/zoo/ModelDrawer.java b/jsondiscoverer.zoo/src/jsondiscoverer/zoo/ModelDrawer.java
@@ -32,6 +32,12 @@
 import org.emftools.emf2gv.graphdesc.GraphdescPackage;
 import org.emftools.emf2gv.processor.core.StandaloneProcessor;
 
+/**
+ * This class traverses a folder and generates the pictures for each model found
+ * 
+ * @author Javier Canovas ([email protected])
+ *
+ */
 public class ModelDrawer {
 	private final static Logger LOGGER = Logger.getLogger(ModelDrawer.class.getName());
 

diff --git a/jsondiscoverer/src/jsondiscoverer/AbstractJsonSource.java b/jsondiscoverer/src/jsondiscoverer/AbstractJsonSource.java
@@ -17,7 +17,6 @@
  * Common implementation for JSON sources
  * 
  * @author Javier Canovas ([email protected])
- * @version 2.0.0
  *
  */
 public abstract class AbstractJsonSource {

diff --git a/jsondiscoverer/src/jsondiscoverer/AnnotationHelper.java b/jsondiscoverer/src/jsondiscoverer/AnnotationHelper.java
@@ -27,7 +27,6 @@
  * This class provides some helper methods to fill in the metadata in the discovered models
  * 
  * @author Javier Canovas ([email protected])
- * @version 2.0.0
  *
  */
 public class AnnotationHelper {

diff --git a/jsondiscoverer/src/jsondiscoverer/CoreographyBuilder.java b/jsondiscoverer/src/jsondiscoverer/CoreographyBuilder.java
@@ -22,6 +22,14 @@
 
 import jsondiscoverer.util.DijkstraSolver;
 
+/**
+ * This class generates a sequence diagram description for the tool 
+ * js-sequene-diagrams (http://bramp.github.io/js-sequence-diagrams)
+ * out of a path in an EPackage. 
+ * 
+ * @author Javier Canovas ([email protected])
+ *
+ */
 public class CoreographyBuilder {
 	private EPackage domain;
 

diff --git a/jsondiscoverer/src/jsondiscoverer/JsonAdvancedDiscoverer.java b/jsondiscoverer/src/jsondiscoverer/JsonAdvancedDiscoverer.java
@@ -58,7 +58,6 @@
  * This implementation does not depend on Xtext
  * 
  * @author Javier Canovas ([email protected])
- * @version 2.0.0
  *
  */
 public class JsonAdvancedDiscoverer {

diff --git a/jsondiscoverer/src/jsondiscoverer/JsonComposer.java b/jsondiscoverer/src/jsondiscoverer/JsonComposer.java
@@ -35,7 +35,6 @@
  * ecore models discovered by the {@link JSONAdvancedDsicoverer} 
  * 
  * @author Javier Canovas ([email protected])
- * @version 2.0.0
  *
  */
 public class JsonComposer {

diff --git a/jsondiscoverer/src/jsondiscoverer/JsonData.java b/jsondiscoverer/src/jsondiscoverer/JsonData.java
@@ -20,7 +20,6 @@
  * the input (as JSON) and the output (as JSON) of the service given such an input.
  * 
  * @author Javier Canovas ([email protected])
- * @version 2.0.0
  *
  */
 class JsonData {

diff --git a/jsondiscoverer/src/jsondiscoverer/JsonInjector.java b/jsondiscoverer/src/jsondiscoverer/JsonInjector.java
@@ -37,7 +37,6 @@
  * This implementation does not depend on Xtext
  * 
  * @author Javier Canovas ([email protected])
- * @version 2.0.0
  *
  */
 public class JsonInjector {

diff --git a/jsondiscoverer/src/jsondiscoverer/JsonSimpleDiscoverer.java b/jsondiscoverer/src/jsondiscoverer/JsonSimpleDiscoverer.java
@@ -41,7 +41,6 @@
  * This implementation does not depend on Xtext (v0.1.0)
  * 
  * @author Javier Canovas ([email protected])
- * @version 2.0.0
  *
  */
 public class JsonSimpleDiscoverer {

diff --git a/jsondiscoverer/src/jsondiscoverer/JsonSource.java b/jsondiscoverer/src/jsondiscoverer/JsonSource.java
@@ -26,7 +26,6 @@
  * (i.e., set of JSON documents returned by the same JSON-based Web API)
  * 
  * @author Javier Canovas ([email protected])
- * @version 2.0.0
  *
  */
 public class JsonSource extends AbstractJsonSource {

diff --git a/jsondiscoverer/src/jsondiscoverer/JsonSourceSet.java b/jsondiscoverer/src/jsondiscoverer/JsonSourceSet.java
@@ -19,7 +19,6 @@
  * (i.e., several examples of different JSON-based API calls)
  * 
  * @author Javier Canovas ([email protected])
- * @version 2.0.0
  *
  */
 public class JsonSourceSet extends AbstractJsonSource {

diff --git a/jsondiscoverer/src/jsondiscoverer/SingleJsonSource.java b/jsondiscoverer/src/jsondiscoverer/SingleJsonSource.java
@@ -20,7 +20,6 @@
  * with ONE JSON document and WITHOUT input
  * 
  * @author Javier Canovas ([email protected])
- * @version 2.0.0
  *
  */
 public class SingleJsonSource extends JsonSource {

diff --git a/jsondiscoverer/src/jsondiscoverer/util/DijkstraSolver.java b/jsondiscoverer/src/jsondiscoverer/util/DijkstraSolver.java
@@ -1,3 +1,16 @@
+/*******************************************************************************
+ * Copyright (c) 2008, 2015
+ * All rights reserved. This program and the accompanying materials
+ * are made available under the terms of the Eclipse Public License v1.0
+ * which accompanies this distribution, and is available at
+ * http://www.eclipse.org/legal/epl-v10.html
+ *
+ * Contributors:
+ *    Javier Canovas ([email protected]) 
+ *******************************************************************************/
+
+
+
 package jsondiscoverer.util;
 
 import java.util.ArrayList;

diff --git a/jsondiscoverer/src/jsondiscoverer/util/GexfConverter.java b/jsondiscoverer/src/jsondiscoverer/util/GexfConverter.java
@@ -1,3 +1,16 @@
+/*******************************************************************************
+ * Copyright (c) 2008, 2015
+ * All rights reserved. This program and the accompanying materials
+ * are made available under the terms of the Eclipse Public License v1.0
+ * which accompanies this distribution, and is available at
+ * http://www.eclipse.org/legal/epl-v10.html
+ *
+ * Contributors:
+ *    Javier Canovas ([email protected]) 
+ *******************************************************************************/
+
+
+
 package jsondiscoverer.util;
 
 import java.sql.Timestamp;

diff --git a/jsondiscoverer/src/jsondiscoverer/util/ModelHelper.java b/jsondiscoverer/src/jsondiscoverer/util/ModelHelper.java
@@ -30,7 +30,6 @@
  * Utility class con basic model actions
  * 
  * @author Javier Canovas ([email protected])
- * @version 1.0.0
  *
  */
 public class ModelHelper {