rename instance doc to phetioDocumentation, phetsims/tandem#63

js/NavigationBar.js

@@ -134,7 +134,7 @@ define( function( require ) {
       font: new PhetFont( 16 ),
       fill: sim.lookAndFeel.navigationBarTextFillProperty,
       tandem: tandem.createTandem( 'titleTextNode' ),
-      phetioInstanceDocumentation: 'Displays the title of the simulation in the navigation bar (bottom left)'
+      phetioDocumentation: 'Displays the title of the simulation in the navigation bar (bottom left)'
     } );
     this.titleTextNode.setVisible( false );
     this.barContents.addChild( this.titleTextNode );

js/NavigationBarScreenButton.js

@@ -101,7 +101,7 @@ define( function( require ) {
     // Hook up the input listener
     var pressListener = this.buttonModel.createListener( {
       tandem: options.tandem.createTandem( 'pressListener' ),
-      phetioInstanceDocumentation: 'Indicates when the screen button has been pressed or released'
+      phetioDocumentation: 'Indicates when the screen button has been pressed or released'
     } );
 
     this.addInputListener( pressListener );

js/PhetButton.js

@@ -82,7 +82,7 @@ define( function( require ) {
         phetMenu.show();
       },
       phetioType: PhetButtonIO,
-      phetioInstanceDocumentation: 'The button that appears at the right side of the navigation bar, which shows a menu when pressed',
+      phetioDocumentation: 'The button that appears at the right side of the navigation bar, which shows a menu when pressed',
 
       // a11y
       tagName: 'button',

js/PhetButtonIO.js

@@ -42,7 +42,7 @@ define( function( require ) {
 
       tandem: phetButton.tandem.createTandem( 'pickableProperty' ),
       phetioType: PropertyIO( NullableIO( BooleanIO ) ),
-      phetioInstanceDocumentation: 'Set whether the phetButton will be pickable (and hence interactive), see the NodeIO documentation for more details'
+      phetioDocumentation: 'Set whether the phetButton will be pickable (and hence interactive), see the NodeIO documentation for more details'
     } );
 
     // @private

js/PhetMenu.js

@@ -100,7 +100,7 @@ define( function( require ) {
 
       phetioType: PhetMenuIO,
       phetioState: false,
-      phetioInstanceDocumentation: 'This menu is displayed when the PhET button is pressed.',
+      phetioDocumentation: 'This menu is displayed when the PhET button is pressed.',
 
       // a11y, tagname and role for content in the menu
       tagName: 'ul',
@@ -133,7 +133,7 @@ define( function( require ) {
           optionsDialog.show();
         },
         tandem: tandem.createTandem( 'optionsMenuItem' ),
-        phetioInstanceDocumentation: 'This menu item shows an options dialog.',
+        phetioDocumentation: 'This menu item shows an options dialog.',
         phetioState: false,
 
         // a11y
@@ -274,7 +274,7 @@ define( function( require ) {
           }
         },
         tandem: tandem.createTandem( 'screenshotMenuItem' ),
-        phetioInstanceDocumentation: 'This menu item captures a screenshot from the simulation and saves it to the file system.',
+        phetioDocumentation: 'This menu item captures a screenshot from the simulation and saves it to the file system.',
         phetioState: false,
         tagName: 'button'
       },
@@ -288,7 +288,7 @@ define( function( require ) {
           soundManager.enhancedSoundEnabledProperty.set( !soundManager.enhancedSoundEnabledProperty.get() );
         },
         tandem: tandem.createTandem( 'enhancedSoundMenuItem' ),
-        phetioInstanceDocumentation: 'This menu item toggles between basic and enhanced sound modes.',
+        phetioDocumentation: 'This menu item toggles between basic and enhanced sound modes.',
         phetioState: false,
         tagName: 'button'
       },
@@ -302,7 +302,7 @@ define( function( require ) {
           FullScreen.toggleFullScreen( sim.display );
         },
         tandem: tandem.createTandem( 'fullScreenMenuItem' ),
-        phetioInstanceDocumentation: 'This menu item requests full-screen access for the simulation display.',
+        phetioDocumentation: 'This menu item requests full-screen access for the simulation display.',
         phetioState: false,
 
         // a11y
@@ -323,7 +323,7 @@ define( function( require ) {
           aboutDialog.show();
         },
         tandem: tandem.createTandem( 'aboutMenuItem' ),
-        phetioInstanceDocumentation: 'This menu item shows a dialog with information about the simulation.',
+        phetioDocumentation: 'This menu item shows a dialog with information about the simulation.',
         tagName: 'button',
         focusAfterCallback: true,
         phetioReadOnly: true,
@@ -352,7 +352,7 @@ define( function( require ) {
           separatorBefore: itemDescriptor.separatorBefore,
           tagName: itemDescriptor.tagName,
           tandem: itemDescriptor.tandem,
-          phetioInstanceDocumentation: itemDescriptor.phetioInstanceDocumentation,
+          phetioDocumentation: itemDescriptor.phetioDocumentation,
           focusAfterCallback: itemDescriptor.focusAfterCallback,
           phetioReadOnly: itemDescriptor.phetioReadOnly,
           phetioState: itemDescriptor.phetioState

js/Screen.js

@@ -131,7 +131,7 @@ define( function( require ) {
       tandem: options.tandem.createTandem( 'activeProperty' ),
       phetioType: PropertyIO( BooleanIO ),
       phetioReadOnly: true,
-      phetioInstanceDocumentation: 'Indicates whether the screen is active.  For single-screen simulations, the screen is always active.'
+      phetioDocumentation: 'Indicates whether the screen is active.  For single-screen simulations, the screen is always active.'
     } );
 
     // @public (a11y) - used to set the ScreenView's descriptionContent. This is a bit of a misnomer because Screen is

js/Sim.js

@@ -217,7 +217,7 @@ define( function( require ) {
     // @public (joist-internal) - The selected screen's index
     this.screenIndexProperty = new NumberProperty( options.screenIndex, {
       tandem: ROOT_TANDEM.createTandem( 'screenIndexProperty' ),
-      phetioInstanceDocumentation: 'Indicates which screen is selected (0-indexed)',
+      phetioDocumentation: 'Indicates which screen is selected (0-indexed)',
       validValues: _.range( 0, screens.length ),
       numberType: 'Integer'
     } );
@@ -227,15 +227,15 @@ define( function( require ) {
     // activeProperty will automatically be set to false so the timing and inputs can be controlled by the playback engine
     this.activeProperty = new BooleanProperty( !phet.joist.playbackModeEnabledProperty.value, {
       tandem: ROOT_TANDEM.createTandem( 'activeProperty' ),
-      phetioInstanceDocumentation: 'Determines whether the entire simulation is running and processing user input. ' +
-                                   'Setting this property to false pauses the simulation, and prevents user interaction.',
+      phetioDocumentation: 'Determines whether the entire simulation is running and processing user input. ' +
+                           'Setting this property to false pauses the simulation, and prevents user interaction.',
       phetioType: PropertyIO( BooleanIO )
     } );
 
     // @public (read-only) - property that indicates whether the browser tab containing the simulation is currently visible
     this.browserTabVisibleProperty = new BooleanProperty( true, {
       tandem: ROOT_TANDEM.createTandem( 'browserTabVisibleProperty' ),
-      phetioInstanceDocumentation: 'Indicates whether the browser tab containing the simulation is currently visible',
+      phetioDocumentation: 'Indicates whether the browser tab containing the simulation is currently visible',
       phetioReadOnly: true
     } );
 
@@ -548,7 +548,7 @@ define( function( require ) {
           fill: 'rgba(0,0,0,0.3)',
           pickable: true,
           tandem: ROOT_TANDEM.createTandem( 'barrierRectangle' ),
-          phetioInstanceDocumentation: 'Semi-transparent barrier used to block input events when a dialog is shown, also fades out the background'
+          phetioDocumentation: 'Semi-transparent barrier used to block input events when a dialog is shown, also fades out the background'
         } );
       this.topLayer.addChild( this.barrierRectangle );