add type docs to alert manager and describer subtypes, phetsims/gravi…

…ty-force-lab-basics#161
phetsims · Jul 1, 2019 · 6102105 · 6102105
1 parent 986a39f
commit 6102105
Show file tree

Hide file tree

Showing 3 changed files with 9 additions and 0 deletions.
diff --git a/js/gravity-force-lab/view/GravityForceLabAlertManager.js b/js/gravity-force-lab/view/GravityForceLabAlertManager.js
@@ -1,5 +1,8 @@
 // Copyright 2018-2019, University of Colorado Boulder
 
+/**
+ * This alert manager is responsible for all gravity-force-lab specific aria-live alerts.
+ */
 define( require => {
   'use strict';
 

diff --git a/js/gravity-force-lab/view/describers/GravityForceLabForceDescriber.js b/js/gravity-force-lab/view/describers/GravityForceLabForceDescriber.js
@@ -1,5 +1,8 @@
 // Copyright 2018-2019, University of Colorado Boulder
 
+/**
+ * This describer is responsible for all gravity-force-lab specific string forming related to force.
+ */
 define( require => {
   'use strict';
 

diff --git a/js/gravity-force-lab/view/describers/GravityForceLabPositionDescriber.js b/js/gravity-force-lab/view/describers/GravityForceLabPositionDescriber.js
@@ -1,5 +1,8 @@
 // Copyright 2019, University of Colorado Boulder
 
+/**
+ * This describer is responsible for all gravity-force-lab specific string forming related to position.
+ */
 define( require => {
   'use strict';