Added PhET-iO documentation, see phetsims/faradays-law#79

phetsims · Mar 26, 2018 · 4ba9468 · 4ba9468
1 parent 26598a5
commit 4ba9468
Showing 1 changed file with 1 addition and 0 deletions.
diff --git a/js/buttons/ResetAllButton.js b/js/buttons/ResetAllButton.js
@@ -65,6 +65,7 @@ define( function( require ) {
     // @private - Mirrored property of `buttonModel.isFiringProperty`, but is phet-io instrumented.
     this.isFiringProperty = new DerivedProperty( [ this.buttonModel.isFiringProperty ], function( a ) { return a; }, {
       tandem: options.tandem.createTandem( 'isFiringProperty' ),
+      phetioInstanceDocumentation: 'Temporarily becomes true while the Reset All button is firing.  Commonly used to disable audio effects during reset.',
       phetioType: DerivedPropertyIO( BooleanIO ),
       phetioState: options.phetioState,
       phetioReadOnly: options.phetioReadOnly