Fixed documentation, introduced invokes, refactored visitor

Author: Sebastian Höfer

…/javascript/api/model/ArrayDeclares.java …ArrayDeclaresRelationshipDescriptor.javasrc/main/java/org/jqassistant/contrib/plugin/javascript/api/model/ArrayDeclares.java renamed to src/main/java/org/jqassistant/contrib/plugin/javascript/api/model/ArrayDeclaresRelationshipDescriptor.java src/main/java/org/jqassistant/contrib/plugin/javascript/api/model/ArrayDeclares.java renamed to src/main/java/org/jqassistant/contrib/plugin/javascript/api/model/ArrayDeclaresRelationshipDescriptor.java

@@ -7,11 +7,12 @@
 import com.buschmais.xo.neo4j.api.annotation.Relation.Outgoing;
 
 /**
- * JS Array Declares
+ * Interface that describes the relations of an {@link ArrayDescriptor} to its indexed values. 
+ * 
  * @author sh20xyqi
  */
 @Relation("DECLARES_ARRAY")
-public interface ArrayDeclares extends Descriptor {
+public interface ArrayDeclaresRelationshipDescriptor extends Descriptor {
 
 	@Outgoing
 	ArrayDescriptor getArrayDescriptor();

src/main/java/org/jqassistant/contrib/plugin/javascript/api/model/ArrayDescriptor.java

@@ -4,10 +4,10 @@
 
 import com.buschmais.jqassistant.core.store.api.model.FullQualifiedNameDescriptor;
 import com.buschmais.xo.neo4j.api.annotation.Label;
-import com.buschmais.xo.neo4j.api.annotation.Relation.Outgoing;
 
 /**
- * ECMAScript Object Baseclass
+ * Interface used to describe the special type of a {@link BaseObjectDescriptor} called array.
+ * 
  * @author sh20xyqi
  */
 @Label(value = "Array", usingIndexedPropertyOf = FullQualifiedNameDescriptor.class)
@@ -19,8 +19,11 @@ public interface ArrayDescriptor extends BaseObjectDescriptor {
 	default String getFullQualifiedName() {
 		return ARRAY;
 	}
-	
-	@Outgoing
-	List<ArrayDeclares> getArrayDeclares();
+	/**
+     * Returns all index {@link ArrayDeclaresRelationshipDescriptor} of this array.
+     *
+     * @return The elements of the array.
+     */
+	List<ArrayDeclaresRelationshipDescriptor> getArrayDeclares();
 }
 

src/main/java/org/jqassistant/contrib/plugin/javascript/api/model/BaseObjectDescriptor.java

@@ -6,10 +6,11 @@
 import com.buschmais.xo.neo4j.api.annotation.Label;
 
 /**
- * ECMAScript Object Baseclass
+ * Interface for the description of data structures, which can be either an {@link ObjectDescriptor} or an {@kink ArrayDescriptor}.
+ * 
  * @author sh20xyqi
  */
-@Label(value = "ObjectType", usingIndexedPropertyOf = FullQualifiedNameDescriptor.class)
+@Label(value ="", usingIndexedPropertyOf = FullQualifiedNameDescriptor.class)
 public interface BaseObjectDescriptor extends CodeArtifact, FullQualifiedNameDescriptor {
 
 	public static final AtomicInteger count = new AtomicInteger(0);

src/main/java/org/jqassistant/contrib/plugin/javascript/api/model/BooleanDescriptor.java

@@ -2,5 +2,11 @@
 
 import com.buschmais.xo.neo4j.api.annotation.Label;
 
+/**
+ * Interface for describing the primitive data type Boolean.
+ * 
+ * @author sh20xyqi
+ */
+
 @Label("Boolean")
 public interface BooleanDescriptor extends LiteralDescriptor<Boolean>{}

src/main/java/org/jqassistant/contrib/plugin/javascript/api/model/ClassAttributeDescriptor.java

@@ -4,22 +4,23 @@
 import com.buschmais.xo.neo4j.api.annotation.Property;
 
 /**
- * ECMAScript Class Descriptor
+ * Interface for describing a class.
+ * 
  * @author sh20xyqi
  */
 @Label(value = "Class", usingIndexedPropertyOf = FullQualifiedNameDescriptor.class)
 public interface ClassDescriptor extends JsDescriptor, CodeArtifact, FullQualifiedNameDescriptor {
 
 	/**
-     * Returns the name of the class
+     * Returns the name of the class.
      * @return String 
      */
 	@Property("NAME")
     String getName();
     void setName(String name);
 
     /**
-     * Returns the super class of the class
+     * Returns the super class of the class.
      * @return String
      */
     @Property("EXTENDS")

src/main/java/org/jqassistant/contrib/plugin/javascript/api/model/ClassDescriptor.java

@@ -5,41 +5,54 @@
 import com.buschmais.jqassistant.core.store.api.model.FullQualifiedNameDescriptor;
 import com.buschmais.xo.neo4j.api.annotation.Relation;
 
-public interface CodeArtifact extends  FullQualifiedNameDescriptor, LineNumberDescriptor {
+/**
+ * Interface to describe a JavaScript code artifact.
+ * 
+ * @author sh20xyqi
+ */
+
+public interface CodeArtifact extends FullQualifiedNameDescriptor, LineNumberDescriptor {
 
 	public static final String DECLARES = "DECLARES";
 
 	/**
-     * declared functions
-     * @return list of functions 
+     * Contains all named and anonymous {@link FunctionDescriptor} that occur in this code artifact.
+     * @return List of functions
      */
     @Relation(DECLARES)
     List<FunctionDescriptor> getFunctions();
 
+	/**
+     * Contains all functions that were called by another {@link FunctionDescriptor}.
+     * @return List of invoked functions 
+     */
+    @Relation("INVOKES")
+    List<FunctionDescriptor> getInvokes();
+    
     /**
-     * declared classes
-     * @return list of classes
+     * Contains all named and anonymous {@link ClassDescriptor} that occur in this JavaScript code artifact.
+     * @return List of classes
      */
     @Relation(DECLARES)
     List<ClassDescriptor> getClasses();
 
     /**
-     * declared objects
-     * @return list of objects 
+     * Contains all named and anonymous {@link BaseObjectDescriptor} (e.g. {@link ObjectDescriptor} or {@link ArrayDescriptor}) that occur in this JavaScript code artifact.
+     * @return List of objects 
      */
     @Relation(DECLARES)
     List<BaseObjectDescriptor> getObjects();
 
     /**
-     * declared variables
-     * @return list of variables
+     * Contains all named and anonymous {@link VariableDescriptor} that occur in this JavaScript code artifact.
+     * @return List of variables
      */
     @Relation(DECLARES)
     List<VariableDescriptor> getVariables();
 
     /**
-     * declared literals
-     * @return list of literals
+     * Contains all named and anonymous {@link LiteralDescriptor} (also called primitive data types) that occur in this JavaScript code artifact.
+     * @return List of literals (primitive data types)
      */
     @Relation(DECLARES)
     List<LiteralDescriptor<?>> getLiterals();

src/main/java/org/jqassistant/contrib/plugin/javascript/api/model/ClassMethodDescriptor.java

@@ -7,14 +7,15 @@
 import java.util.List;
 
 /**
- * ECMAScript function
+ * Interface to describe a named or anonymous function.
+ * 
  * @author sh20xyqi
  */
 @Label(value = "Function", usingIndexedPropertyOf = FullQualifiedNameDescriptor.class)
 public interface FunctionDescriptor extends JsDescriptor, FullQualifiedNameDescriptor, CodeArtifact {
 
 	/**
-     * Return the name of a function.
+     * Returns the name of the function.
      *
      * @return The name.
      */
@@ -23,7 +24,7 @@ public interface FunctionDescriptor extends JsDescriptor, FullQualifiedNameDescr
     void setName(String name);
 
     /**
-     * Return all declared parameters of this function.
+     * Returns all declared {@link FunctionParameterDescriptor} of this function.
      *
      * @return The declared parameters.
      */