scratchfoundation/scratch-vm
1
0
Fork 0
mirror of https://github.com/scratchfoundation/scratch-vm.git synced 2024-12-24 15:02:52 -05:00
Code Issues Projects Releases Packages Wiki Activity Actions 1

Update code comments to address PR feedback

Browse source
This commit is contained in:
Connor Hudson 2018-06-11 08:37:25 -04:00
parent 78da15c09c
commit 38756e1022
1 changed files with 7 additions and 9 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

14
src/engine/runtime.js
View file

@ -1518,7 +1518,7 @@ class Runtime extends EventEmitter {
/** /**
* Add a monitor to the state. If the monitor already exists in the state, * Add a monitor to the state. If the monitor already exists in the state,
* overwrites it. * updates those properties that are defined in the given monitor record.
* @param {!MonitorRecord} monitor Monitor to add. * @param {!MonitorRecord} monitor Monitor to add.
*/ */
requestAddMonitor (monitor) { requestAddMonitor (monitor) {
@ -1530,8 +1530,7 @@ class Runtime extends EventEmitter {
} }
/** /**
* Update a monitor in the state. Does nothing and returns false if the monitor does not already * Update a monitor in the state and report success/failure of update.
* exist in the state.
* @param {!Map} monitor Monitor values to update. Values on the monitor with overwrite * @param {!Map} monitor Monitor values to update. Values on the monitor with overwrite
* values on the old monitor with the same ID. If a value isn't defined on the new monitor, * values on the old monitor with the same ID. If a value isn't defined on the new monitor,
* the old monitor will keep its old value. * the old monitor will keep its old value.
@ -1563,9 +1562,8 @@ class Runtime extends EventEmitter {
} }
/** /**
* Hides a monitor. Does nothing if the monitor already does * Hides a monitor and returns success/failure of action.
* not exist in the state. * @param {!string} monitorId ID of the monitor to hide.
* @param {!string} monitorId ID of the monitor to remove.
* @return {boolean} true if monitor exists and was updated, false otherwise * @return {boolean} true if monitor exists and was updated, false otherwise
*/ */
requestHideMonitor (monitorId) { requestHideMonitor (monitorId) {
@ -1576,9 +1574,9 @@ class Runtime extends EventEmitter {
} }
/** /**
* Shows a monitor. Does nothing if the monitor already does * Shows a monitor and returns success/failure of action.
* not exist in the state. * not exist in the state.
* @param {!string} monitorId ID of the monitor to remove. * @param {!string} monitorId ID of the monitor to show.
* @return {boolean} true if monitor exists and was updated, false otherwise * @return {boolean} true if monitor exists and was updated, false otherwise
*/ */
requestShowMonitor (monitorId) { requestShowMonitor (monitorId) {