Last polishing in the code (comments basically and docs)

jlcanovas · jlcanovas · commit 4aff97f9084c · 2015-09-01T09:34:26.000+02:00
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 (me@jlcanovas.es) 
+ *******************************************************************************/
+
+
 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 (me@jlcanovas.es)
- * @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 (me@jlcanovas.es)
- * @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 (me@jlcanovas.es)
- * @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 (me@jlcanovas.es)
- * @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 (me@jlcanovas.es)
- * @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 (me@jlcanovas.es)
- * @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 (me@jlcanovas.es)
- * @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 (me@jlcanovas.es)
- * @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 (me@jlcanovas.es)
- * @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 (me@jlcanovas.es)
+ *
+ */
 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 (me@jlcanovas.es)
- * @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 (me@jlcanovas.es)
- * @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 (me@jlcanovas.es)
+ *
+ */
 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 (me@jlcanovas.es)
- * @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 (me@jlcanovas.es)
- * @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 (me@jlcanovas.es)
- * @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 (me@jlcanovas.es)
- * @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 (me@jlcanovas.es)
- * @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 (me@jlcanovas.es)
- * @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 (me@jlcanovas.es)
- * @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 (me@jlcanovas.es)
- * @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 (me@jlcanovas.es) 
+ *******************************************************************************/
+
+
+
 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 (me@jlcanovas.es) 
+ *******************************************************************************/
+
+
+
 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 (me@jlcanovas.es)
- * @version 1.0.0
  *
  */
 public class ModelHelper {

Original file line number	Diff line number	Diff line change
`@@ -45,7 +45,6 @@`
`45`	`45`	`* Abstract class to factor some common behavior`
`46`	`46`	`*`
`47`	`47`	`* @author Javier Canovas ([email protected])`
`48`		`- * @version 2.0.0`
`49`	`48`	`*`
`50`	`49`	`*/`
`51`	`50`	`public abstract class AbstractJsonDiscoverer extends HttpServlet {`
Original file line number	Diff line number	Diff line change
`@@ -40,7 +40,6 @@`
`40`	`40`	`* Main servlet to provide access to {@link JsonAdvancedDiscoverer}`
`41`	`41`	`*`
`42`	`42`	`* @author Javier Canovas ([email protected])`
`43`		`- * @version 2.0.0`
`44`	`43`	`*`
`45`	`44`	`*/`
`46`	`45`	`@WebServlet("/advancedDiscover")`
Original file line number	Diff line number	Diff line change
`@@ -39,7 +39,6 @@`
`39`	`39`	`* ervlet to access to {@link JsonComposer}`
`40`	`40`	`*`
`41`	`41`	`* @author Javier Canovas ([email protected])`
`42`		`- * @version 2.0.0`
`43`	`42`	`*`
`44`	`43`	`*/`
`45`	`44`	`@WebServlet("/composer")`
Original file line number	Diff line number	Diff line change
`@@ -33,7 +33,6 @@`
`33`	`33`	`* This servlet gives access to the {@link JsonInjector}`
`34`	`34`	`*`
`35`	`35`	`* @author Javier Canovas ([email protected])`
`36`		`- * @version 2.0.0`
`37`	`36`	`*`
`38`	`37`	`*/`
`39`	`38`	`@WebServlet("/simpleDiscoverModel")`
Original file line number	Diff line number	Diff line change
`@@ -34,7 +34,6 @@`
`34`	`34`	`* This servlet allows calculating paths between nodes of the discovered metamodel`
`35`	`35`	`*`
`36`	`36`	`* @author Javier Canovas ([email protected])`
`37`		`- * @version 2.0.0`
`38`	`37`	`*`
`39`	`38`	`*/`
`40`	`39`	`@WebServlet("/calculatePath")`
Original file line number	Diff line number	Diff line change
`@@ -35,7 +35,6 @@`
`35`	`35`	`* Main class that provides the main access to {@link JsonSimpleDiscoverer}`
`36`	`36`	`*`
`37`	`37`	`* @author Javier Canovas ([email protected])`
`38`		`- * @version 2.0.0`
`39`	`38`	`*`
`40`	`39`	`*/`
`41`	`40`	`@WebServlet("/simpleDiscoverMetamodel")`
Original file line number	Diff line number	Diff line change
`@@ -31,7 +31,6 @@`
`31`	`31`	`* LIMIT_LINES to avoid overloading the server.`
`32`	`32`	`*`
`33`	`33`	`* @author Javier Canovas ([email protected])`
`34`		`- * @version 2.0.0`
`35`	`34`	`*`
`36`	`35`	`*/`
`37`	`36`	`@WebServlet("/getJson")`
Original file line number	Diff line number	Diff line change
`@@ -25,7 +25,6 @@`
`25`	`25`	`* Simple servlet to know the versions of the other servlets`
`26`	`26`	`*`
`27`	`27`	`* @author Javier Canovas ([email protected])`
`28`		`- * @version 2.0.0`
`29`	`28`	`*`
`30`	`29`	`*/`
`31`	`30`	`@WebServlet("/status")`
Original file line number	Diff line number	Diff line change
`@@ -14,7 +14,6 @@`
`14`	`14`	`* Super simple servlet to know the versio running in the server`
`15`	`15`	`*`
`16`	`16`	`* @author Javier Canovas ([email protected])`
`17`		`- * @version 2.0.0`
`18`	`17`	`*`
`19`	`18`	`*/`
`20`	`19`	`@WebServlet("/version")`