chore(*): add definition of how we use includeDerivedTypes in JSDoc

Signed-off-by: muhammed-abdulkadir <[email protected]>

lib/common/graph.js

@@ -174,6 +174,8 @@ class ConcertoGraphVisitor extends BaseVisitor {
      * Visitor design pattern
      * @param {ClassDeclaration} classDeclaration - the object being visited
      * @param {Object} parameters  - the parameter
+     * @property {boolean} parameters.includeDerivedTypes - If this option is enabled, edges will be created from super types to their derived types.
+     * This guarantees that if type X exists in the model manager, all types that inherit from X will be represented in the graph.
      * @protected
      */
     visitClassDeclaration(classDeclaration, parameters) {
@@ -183,7 +185,7 @@ class ConcertoGraphVisitor extends BaseVisitor {
             parameters.graph.addEdge(classDeclaration.getFullyQualifiedName(), classDeclaration.getSuperType());
 
             // Adds a reverse edge to create a cyclic dependency between a class declaration and its supertype.
-            if(!parameters.createDependencyGraph && classDeclaration.getSuperType() !== '[email protected]') {
+            if(parameters.includeDerivedTypes && classDeclaration.getSuperType() !== '[email protected]') {
                 parameters.graph.addVertex(classDeclaration.getSuperType());
                 parameters.graph.addEdge(classDeclaration.getSuperType(), classDeclaration.getFullyQualifiedName());
             }

test/common/graph.js

@@ -57,7 +57,7 @@ describe('graph', function() {
             const writer = new InMemoryWriter();
 
             const graph = new DirectedGraph();
-            modelManager.accept(visitor, { graph });
+            modelManager.accept(visitor, { graph, includeDerivedTypes: true });
 
             writer.openFile('graph.mmd');
             graph.print(writer);
@@ -71,7 +71,7 @@ describe('graph', function() {
             const writer = new InMemoryWriter();
 
             const graph = new DirectedGraph();
-            modelManager.accept(visitor, { graph });
+            modelManager.accept(visitor, { graph, includeDerivedTypes: true });
 
             const connectedGraph = graph.findConnectedGraph(
                 '[email protected]'
@@ -106,7 +106,7 @@ describe('graph', function() {
             const graph = new DirectedGraph();
             modelManager.accept(visitor, {
                 graph,
-                createDependencyGraph: true
+                includeDerivedTypes: false
             });
 
             expect(

types/lib/common/graph.d.ts

@@ -11,6 +11,8 @@ export class ConcertoGraphVisitor extends BaseVisitor {
      * Visitor design pattern
      * @param {ClassDeclaration} classDeclaration - the object being visited
      * @param {Object} parameters  - the parameter
+     * @property {boolean} parameters.includeDerivedTypes - If this option is enabled, edges will be created from super types to their derived types.
+     * This guarantees that if type X exists in the model manager, all types that inherit from X will be represented in the graph.
      * @protected
      */
     protected visitClassDeclaration(classDeclaration: ClassDeclaration, parameters: any): void;