Commit 035fdb89 authored by Patrik Meijer's avatar Patrik Meijer
Browse files

Add some documentation to GraphEditor pieces

parent 42e8db65
Loading
Loading
Loading
Loading
+1 −2
Changes for src/components/GraphEditor/ContextMenu.jsx: 1 added line, 2 removed lines.
Original line number Diff line number Diff line
/* globals document */
/**
 * DISTRIBUTION STATEMENT C: U.S. Government agencies and their contractors.
 * Other requests shall be referred to DARPA’s Public Release Center via email at prc@darpa.mil.
 * TODO: Consider moving this outside of the GraphEditor and let it be passed as child instead.
 * @author pmeijer / https://github.com/pmeijer
 */
import React, {Component} from 'react';
+1 −2
Changes for src/components/GraphEditor/FilterSelector.jsx: 1 added line, 2 removed lines.
Original line number Diff line number Diff line
/**
 * DISTRIBUTION STATEMENT C: U.S. Government agencies and their contractors.
 * Other requests shall be referred to DARPA’s Public Release Center via email at prc@darpa.mil.
 * Dialog for selecting what parts should be filtered out in the GraphEditor.
 * @author pmeijer / https://github.com/pmeijer
 */
import React, {Component} from 'react';
+3 −6
Changes for src/components/GraphEditor/GraphEditor.jsx: 3 added lines, 6 removed lines.
Original line number Diff line number Diff line
/**
 * DISTRIBUTION STATEMENT C: U.S. Government agencies and their contractors.
 * Other requests shall be referred to DARPA’s Public Release Center via email at prc@darpa.mil.
 *
 * This component receives the data from the gme nodes and builds up the input data for cytoscape.
 * It is relatively domain-agnostic, mainly the styles are tied with DCRYPPS (apart from what is passed in via the
 * options such as filters).
 * This component takes the generated nodes from SubTreeWatcher and
 * populates the data in a cytoscape graph.
 * The GraphEditor should be passed as a child to the SubTreeWatcher, see ./demo.jsx for example.
 * @author pmeijer / https://github.com/pmeijer
 */

+0 −2
Changes for src/components/GraphEditor/ReactCytoscape.jsx: 0 added lines, 2 removed lines.
Original line number Diff line number Diff line
/**
 * DISTRIBUTION STATEMENT C: U.S. Government agencies and their contractors.
 * Other requests shall be referred to DARPA’s Public Release Center via email at prc@darpa.mil.
 * React wrapper around cytoscape. If scalability ever becomes and issue - consider implementing a fine-grained
 * element update.
 * @author pmeijer / https://github.com/pmeijer