Added JSDoc about components that exist for the life of the sim and h…

…ence do not require a dispose implementation, see #317

js/model/ChargeAnimator.js

@@ -2,7 +2,7 @@
 
 /**
  * This code governs the movement of charges, making sure they are distributed equally among the different
- * CircuitElements.
+ * CircuitElements.  This exists for the life of the sim and hence does not need a dispose implementation.
  *
  * @author Sam Reid (PhET Interactive Simulations)
  */

js/model/Circuit.js

@@ -2,7 +2,7 @@
 
 /**
  * A collection of circuit elements in the play area, not necessarily connected.  (For instance it could be 2 disjoint
- * circuits).
+ * circuits). This exists for the life of the sim and hence does not need a dispose implementation.
  *
  * @author Sam Reid (PhET Interactive Simulations)
  */

js/model/CircuitConstructionKitModel.js

@@ -1,7 +1,8 @@
 // Copyright 2015-2017, University of Colorado Boulder
 
 /**
- * Contains circuit, voltmeter, ammeter and properties to indicate what mode the model is in.
+ * Contains circuit, voltmeter, ammeter and properties to indicate what mode the model is in. This exists for the life
+ * of the sim and hence does not need a dispose implementation.
  *
  * @author Sam Reid (PhET Interactive Simulations)
  */

js/model/Meter.js

@@ -1,7 +1,7 @@
 // Copyright 2016-2017, University of Colorado Boulder
 
 /**
- * Base class for Ammeter and Voltmeter
+ * Base class for Ammeter and Voltmeter.  Meters for the life of the sim and hence do not need a dispose implementation.
  *
  * @author Sam Reid (PhET Interactive Simulations)
  */

js/model/ModifiedNodalAnalysisCircuit.js

@@ -6,6 +6,8 @@
  * Equations is solved as a linear system.  Here is a good reference that was used during the development of this code
  * https://www.swarthmore.edu/NatSci/echeeve1/Ref/mna/MNA2.html
  *
+ * No listeners are attached and hence no dispose implementation is necessary.
+ *
  * @author Sam Reid (PhET Interactive Simulations)
  */
 define( function( require ) {

js/model/ModifiedNodalAnalysisCircuitElement.js

@@ -1,7 +1,7 @@
 // Copyright 2017, University of Colorado Boulder
 
 /**
- * Circuit element used for Modified Nodal Analysis.
+ * Circuit element used for Modified Nodal Analysis. * No listeners are attached and hence no dispose implementation is necessary.
  *
  * @author Sam Reid (PhET Interactive Simulations)
  */

js/model/ModifiedNodalAnalysisSolution.js

@@ -1,7 +1,7 @@
 // Copyright 2015-2017, University of Colorado Boulder
 
 /**
- * Sparse solution containing the solved variables from ModifiedNodalAnalysisCircuit
+ * Sparse solution containing the solved variables from ModifiedNodalAnalysisCircuit. * No listeners are attached and hence no dispose implementation is necessary.
  *
  * @author Sam Reid (PhET Interactive Simulations)
  */

js/model/Voltmeter.js

@@ -1,7 +1,8 @@
 // Copyright 2016-2017, University of Colorado Boulder
 
 /**
- * The model for a voltmeter, which has a red and black probe and reads out voltage between vertices/wires.
+ * The model for a voltmeter, which has a red and black probe and reads out voltage between vertices/wires. Exists
+ * for the life of the sim and hence a dispose implementation is not needed.
  *
  * @author Sam Reid (PhET Interactive Simulations)
  */

js/view/AmmeterNode.js

@@ -2,7 +2,7 @@
 
 /**
  * The user interface component with a single probe which reads current values from Wires (not from Vertex or
- * FixedCircuitElement instances).
+ * FixedCircuitElement instances). Exists for the life of the sim and hence does not require a dispose implementation.
  *
  * @author Sam Reid (PhET Interactive Simulations)
  */

js/view/BatteryResistanceControl.js

@@ -1,7 +1,8 @@
 // Copyright 2017, University of Colorado Boulder
 
 /**
- * Controls for showing and changing the battery internal resistance.
+ * Controls for showing and changing the battery internal resistance.  Exists for the life of the sim and hence does not
+ * require a dispose implementation.
  *
  * @author Sam Reid (PhET Interactive Simulations)
  * @author Denzell Barnett (PhET Interactive Simulations)

js/view/ChargeSpeedThrottlingReadoutNode.js

@@ -1,7 +1,8 @@
 // Copyright 2016-2017, University of Colorado Boulder
 
 /**
- * This shows a readout that indicates the speed of the simulation is reduced (to prevent a strobe effect).
+ * This shows a readout that indicates the speed of the simulation is reduced (to prevent a strobe effect). Exists for
+ * the life of the sim and hence does not require a dispose implementation.
  *
  * @author Sam Reid (PhET Interactive Simulations)
  */

js/view/CircuitConstructionKitScreenView.js

@@ -1,7 +1,8 @@
 // Copyright 2015-2017, University of Colorado Boulder
 
 /**
- * Node that represents a single scene or screen, with a circuit, toolbox, sensors, etc.
+ * Node that represents a single scene or screen, with a circuit, toolbox, sensors, etc. Exists for the life of the sim
+ * and hence does not require a dispose implementation.
  *
  * @author Sam Reid (PhET Interactive Simulations)
  */

js/view/CircuitElementToolFactory.js

@@ -1,7 +1,8 @@
 // Copyright 2016-2017, University of Colorado Boulder
 
 /**
- * Creates CircuitElementToolNodes that can be used to create CircuitElements from the toolbox.
+ * Creates CircuitElementToolNodes that can be used to create CircuitElements from the toolbox.  Exists for the life of
+ * the sim and hence does not require a dispose implementation.
  *
  * @author Sam Reid (PhET Interactive Simulations)
  */

js/view/CircuitElementToolNode.js

@@ -1,7 +1,8 @@
 // Copyright 2017, University of Colorado Boulder
 
 /**
- * An icon in the circuit element toolbox/carousel that can be used to create circuit elements.
+ * An icon in the circuit element toolbox/carousel that can be used to create circuit elements. Exists for the life of
+ * the sim and hence does not require a dispose implementation.
  *
  * @author Sam Reid (PhET Interactive Simulations)
  */

js/view/CircuitElementToolbox.js

@@ -1,7 +1,8 @@
 // Copyright 2016-2017, University of Colorado Boulder
 
 /**
- * Toolbox from which CircuitElements can be dragged or returned.
+ * Toolbox from which CircuitElements can be dragged or returned.  Exists for the life of the sim and hence does not
+ * require a dispose implementation.
  *
  * @author Sam Reid (PhET Interactive Simulations)
  */

js/view/CircuitLayerNode.js

@@ -9,6 +9,8 @@
  * socket (in z-ordering). The CircuitElementNode constructors populate different layers of the CircuitLayerNode in
  * their constructors and depopulate in their dispose functions.
  *
+ * Exists for the life of the sim and hence does not require a dispose implementation.
+ *
  * @author Sam Reid (PhET Interactive Simulations)
  * @author Denzell Barnett (PhET Interactive Simulations)
  */

js/view/DisplayOptionsPanel.js

@@ -1,7 +1,8 @@
 // Copyright 2016-2017, University of Colorado Boulder
 
 /**
- * This control panel shows checkboxes for "Show Electrons", etc.
+ * This control panel shows checkboxes for "Show Electrons", etc.  Exists for the life of the sim and hence does not
+ * require a dispose implementation.
  *
  * @author Sam Reid (PhET Interactive Simulations)
  */

js/view/ProbeTextNode.js

@@ -1,7 +1,8 @@
 // Copyright 2016-2017, University of Colorado Boulder
 
 /**
- * Shows the title (above) and dynamic readout (below) for the ammeter and voltmeter.
+ * Shows the title (above) and dynamic readout (below) for the ammeter and voltmeter. Exists for the life of the sim
+ * and hence does not require a dispose implementation.
  *
  * @author Sam Reid (PhET Interactive Simulations)
  */

js/view/RotateBatteryButton.js

@@ -1,7 +1,7 @@
 // Copyright 2017, University of Colorado Boulder
 
 /**
- * Button that reverses a battery
+ * Button that reverses a battery.
  *
  * @author Sam Reid (PhET Interactive Simulations)
  */

js/view/SensorToolbox.js

@@ -1,7 +1,9 @@
 // Copyright 2016-2017, University of Colorado Boulder
 
 /**
- * This is the toolbox on the right hand side from which the voltmeter and ammeter can be dragged/dropped.
+ * This is the toolbox on the right hand side from which the voltmeter and ammeter can be dragged/dropped.  Exists for
+ * the life of the sim and hence does not require a dispose implementation.
+ *
  * @author Sam Reid (PhET Interactive Simulations)
  */
 define( function( require ) {

js/view/ViewRadioButtonGroup.js

@@ -1,7 +1,8 @@
 // Copyright 2017, University of Colorado Boulder
 
 /**
- * Radio buttons that allow the user to choose between Schematic and Lifelike views.
+ * Radio buttons that allow the user to choose between Schematic and Lifelike views. Exists for the life of the sim and
+ * hence does not require a dispose implementation.
  *
  * @author Sam Reid (PhET Interactive Simulations)
  */

js/view/VoltmeterNode.js

@@ -1,7 +1,8 @@
 // Copyright 2016-2017, University of Colorado Boulder
 
 /**
- * Displays the Voltmeter, which has 2 probes and detects potential differences.
+ * Displays the Voltmeter, which has 2 probes and detects potential differences. Exists for the life of the sim and
+ * hence does not require a dispose implementation.
  *
  * @author Sam Reid (PhET Interactive Simulations)
  */

js/view/WireResistivityControl.js

@@ -1,7 +1,8 @@
 // Copyright 2017, University of Colorado Boulder
 
 /**
- * Controls for showing and changing the wire resistivity.
+ * Controls for showing and changing the wire resistivity.  Exists for the life of the sim and hence does not require a
+ * dispose implementation.
  *
  * @author Sam Reid (PhET Interactive Simulations)
  */

js/view/ZoomControlPanel.js

@@ -1,7 +1,8 @@
 // Copyright 2017, University of Colorado Boulder
 
 /**
- * The panel that appears in the bottom left which can be used to zoom in and out on the circuit.
+ * The panel that appears in the bottom left which can be used to zoom in and out on the circuit. Exists for the life
+ * of the sim and hence does not require a dispose implementation.
  *
  * @author Sam Reid (PhET Interactive Simulations)
  */