fix doc issues

VCityTeam · Sep 1, 2023 · ac48136 · ac48136
1 parent 367dab0
commit ac48136
Show file tree

Hide file tree

Showing 5 changed files with 11 additions and 13 deletions.
diff --git a/packages/browser/src/Widget/Server/SPARQL/Model/Graph.js b/packages/browser/src/Widget/Server/SPARQL/Model/Graph.js
@@ -2,8 +2,6 @@
 export class Graph {
   /**
    * Create a new Table using D3.
-   *
-   * @param {object} response A JSON object typically returned by a SparqlEndpointResponseProvider.EVENT_ENDPOINT_RESPONSE_UPDATED event
    */
   constructor() {
     this.nodes = [

diff --git a/packages/browser/src/Widget/Server/SPARQL/View/SparqlQueryWindow.js b/packages/browser/src/Widget/Server/SPARQL/View/SparqlQueryWindow.js
@@ -139,7 +139,7 @@ export class SparqlQueryWindow extends EventSender {
 
     // TODO extract table event listener assignments to example
     this.addEventListener(Table.EVENT_CELL_CLICKED, (cell_text) => {
-      const clickedResult = fetchC3DTileFeatureWithNodeText(
+      const clickedResult = this.fetchC3DTileFeatureWithNodeText(
         URI.getUriLocalname(cell_text)
       );
       if (!clickedResult) return;
@@ -158,12 +158,13 @@ export class SparqlQueryWindow extends EventSender {
     });
   }
 
-
   /**
    * fetchC3DTileFeatureWithNodeText takes a parameter `gmlId` and returns a feature from a `3DTileslayer` if
    * the batch table content of the feature contains a given `gmlid`string in the 'gml_id' key.
-   * @param {string} gmlid a given gml ID.
-   *  */ 
+   * @param {string} gmlId a given gml ID.
+   * @returns {object} containting the feature and the layer containing the feature
+   * 
+   */ 
   fetchC3DTileFeatureWithNodeText(gmlId) {
     let result = null;
     this.itownsView
@@ -189,7 +190,7 @@ export class SparqlQueryWindow extends EventSender {
       });
 
     return result;
-  };
+  }
 
   /**
    * Update the DataView.

diff --git a/packages/browser/src/Widget/Server/Workspace/Model/Workspace.js b/packages/browser/src/Widget/Server/Workspace/Model/Workspace.js
@@ -1,12 +1,10 @@
 import { getUriLocalname } from '../../SPARQL/Model/URI';
-import { SparqlQueryWindow } from '../../SPARQL/View/SparqlQueryWindow';
 import { Graph } from '../../SPARQL/Model/Graph';
 
 export class Workspace extends Graph {
   /**
    * Create a new D3 workspace graph from an RDF JSON object.
    *
-   * @param {SparqlQueryWindow} window the window this graph is attached to.
    * @param {object} configSparqlWidget The sparqlModule configuration.
    * @param {number} configSparqlWidget.height The SVG canvas height.
    * @param {number} configSparqlWidget.width The SVG canvas width.
@@ -88,7 +86,7 @@ export class Workspace extends Graph {
    * the layer.name of the Scenario's localname.
    *
    * @param {number} d the index of the Version or VersionTransition node
-   * @param itownsView
+   * @param {itowns.PlanarView} itownsView view
    * @returns {C3DTilesLayer|null} return the a matching geometryLayer
    */
   getScenarioLayerByIndex(d, itownsView) {

diff --git a/packages/browser/src/Widget/Server/Workspace/View/SparqlWorkspaceQueryWindow.js b/packages/browser/src/Widget/Server/Workspace/View/SparqlWorkspaceQueryWindow.js
@@ -1,5 +1,4 @@
 import { SparqlEndpointResponseProvider } from '../../SPARQL/Service/SparqlEndpointResponseProvider';
-import { getUriLocalname } from '../../SPARQL/Model/URI';
 import { SparqlQueryWindow } from '../../SPARQL/View/SparqlQueryWindow';
 import { D3WorkspaceCanvas } from './D3WorkspaceCanvas';
 import * as itowns from 'itowns';

diff --git a/packages/browser/src/Widget/Temporal/Temporal.js b/packages/browser/src/Widget/Temporal/Temporal.js
@@ -282,10 +282,12 @@ export class Temporal3DTilesLayerWrapper {
       },
     });
 
-    /** @type {Array<number>} - all date possible to update style with (ascending order) */
+    //  all date possible to update style with (ascending order)
+    /** @type {Array<number>} */
     this.knownDatesForAllTiles = knownDatesForAllTiles.sort((a, b) => a - b);
 
-    /** @type {itowns.C3DTilesLayer} - the layer wrapped */
+    // the layer wrapped
+    /** @type {itowns.C3DTilesLayer} */
     this.temporalC3DTilesLayer = temporalC3DTilesLayer;
   }