Updated comments

This commit is contained in:
Jeff Parsons 2014-12-13 11:20:22 -08:00 committed by jeffpar
commit a1f0f6b279
23 changed files with 105 additions and 142 deletions

View file

@ -248,14 +248,12 @@ C1PComputer.power = function(computer)
};
/*
* C1PComputer.init()
* C1PComputer.init()
*
* This function operates on every element (e) of class "computer", and initializes
* all the necessary HTML to construct the C1PComputer(s) as spec'ed.
*
* Note that each element (e) of class "computer" is expected to have a "data-value"
* attribute containing the same JSON-encoded parameters that the C1PComputer constructor
* expects.
* This function operates on every HTML element of class "computer", extracting the
* JSON-encoded parameters for the C1PComputer constructor from the element's "data-value"
* attribute, invoking the constructor to create a C1PComputer component, and then binding
* any associated HTML controls to the new component.
*/
C1PComputer.init = function()
{

View file

@ -3862,14 +3862,12 @@ C1PCPU.prototype.opUndefined = function()
};
/**
* C1PCPU.init()
* C1PCPU.init()
*
* This function operates on every element (e) of class "cpu", and initializes
* all the necessary HTML to construct the CPU module(s) as spec'ed.
*
* Note that each element (e) of class "cpu" is expected to have a "data-value"
* attribute containing the same JSON-encoded parameters that the CPU constructor
* expects.
* This function operates on every HTML element of class "cpu", extracting the
* JSON-encoded parameters for the C1PCPU constructor from the element's "data-value"
* attribute, invoking the constructor to create a C1PCPU component, and then binding
* any associated HTML controls to the new component.
*/
C1PCPU.init = function()
{

View file

@ -2185,12 +2185,10 @@ if (DEBUGGER) {
/**
* C1PDebugger.init()
*
* This function operates on every element (e) of class "debugger", and initializes
* all the necessary HTML to construct the Debugger module(s) as spec'ed.
*
* Note that each element (e) of class "debugger" is expected to have a "data-value"
* attribute containing the same JSON-encoded parameters that the Debugger constructor
* expects.
* This function operates on every HTML element of class "debugger", extracting the
* JSON-encoded parameters for the C1PDebugger constructor from the element's "data-value"
* attribute, invoking the constructor to create a C1PDebugger component, and then binding
* any associated HTML controls to the new component.
*/
C1PDebugger.init = function()
{

View file

@ -1240,12 +1240,10 @@ C1PDiskController.prototype.writePort = function(port, reg)
/**
* C1PDiskController.init()
*
* This function operates on every element (e) of class "disk", and initializes
* all the necessary HTML to construct the DiskController module(s) as spec'ed.
*
* Note that each element (e) of class "disk" is expected to have a "data-value"
* attribute containing the same JSON-encoded parameters that the DiskController
* constructor expects.
* This function operates on every HTML element of class "disk", extracting the
* JSON-encoded parameters for the C1PDiskController constructor from the element's "data-value"
* attribute, invoking the constructor to create a C1PDiskController component, and then binding
* any associated HTML controls to the new component.
*/
C1PDiskController.init = function()
{

View file

@ -1079,12 +1079,10 @@ C1PKeyboard.prototype.updateMemory = function(fPropagate, addr, bWrite)
/**
* C1PKeyboard.init()
*
* This function operates on every element (e) of class "keyboard", and initializes
* all the necessary HTML to construct the Keyboard module(s) as spec'ed.
*
* Note that each element (e) of class "keyboard" is expected to have a "data-value"
* attribute containing the same JSON-encoded parameters that the Keyboard constructor
* expects.
* This function operates on every HTML element of class "keyboard", extracting the
* JSON-encoded parameters for the C1PKeyboard constructor from the element's "data-value"
* attribute, invoking the constructor to create a C1PKeyboard component, and then binding
* any associated HTML controls to the new component.
*/
C1PKeyboard.init = function()
{

View file

@ -89,21 +89,19 @@ C1PPanel.prototype.setPower = function(fOn, cmp)
/**
* C1PPanel.init()
*
* This function operates on every element (e) of class "panel", and initializes
* all the necessary HTML to construct the Panel module(s) as spec'ed.
*
* Note that each element (e) of class "panel" is expected to have a "data-value"
* attribute containing the same JSON-encoded parameters that the Panel constructor
* expects.
* This function operates on every HTML element of class "panel", extracting the
* JSON-encoded parameters for the C1PPanel constructor from the element's "data-value"
* attribute, invoking the constructor to create a C1PPanel component, and then binding
* any associated HTML controls to the new component.
*
* NOTE: Unlike most other component init() functions, this one is designed to be
* called multiple times: once at load time, so that we can binding our print()
* function to the panel's output control ASAP, and again when the Computer component
* function to the panel's output control ASAP, and again when the C1PComputer component
* is verifying that all components are ready and invoking their setPower() functions.
*
* Our setPower() method gives us a second opportunity to notify any components that
* that might care (eg, CPU, Keyboard, and Debugger) that we have some controls they
* might want to use.
* that might care (eg, C1PCPU, C1PKeyboard, and C1PDebugger) that we have some controls
* they might want to use.
*/
C1PPanel.init = function()
{

View file

@ -71,12 +71,10 @@ C1PRAM.prototype.setBuffer = function(abMemory, start, end, cpu)
/**
* C1PRAM.init()
*
* This function operates on every element (e) of class "ram", and initializes
* all the necessary HTML to construct the RAM module(s) as spec'ed.
*
* Note that each element (e) of class "ram" is expected to have a "data-value"
* attribute containing the same JSON-encoded parameters that the RAM constructor
* expects.
* This function operates on every HTML element of class "ram", extracting the
* JSON-encoded parameters for the C1PRAM constructor from the element's "data-value"
* attribute, invoking the constructor to create a C1PRAM component, and then binding
* any associated HTML controls to the new component.
*/
C1PRAM.init = function()
{

View file

@ -214,12 +214,10 @@ C1PROM.prototype.copyImage = function()
/**
* C1PROM.init()
*
* This function operates on every element (e) of class "rom", and initializes
* all the necessary HTML to construct the ROM module(s) as spec'ed.
*
* Note that each element (e) of class "rom" is expected to have a "data-value"
* attribute containing the same JSON-encoded parameters that the ROM constructor
* expects.
* This function operates on every HTML element of class "rom", extracting the
* JSON-encoded parameters for the C1PROM constructor from the element's "data-value"
* attribute, invoking the constructor to create a C1PROM component, and then binding
* any associated HTML controls to the new component.
*/
C1PROM.init = function()
{

View file

@ -377,12 +377,10 @@ C1PSerialPort.prototype.updateMemory = function()
/**
* C1PSerialPort.init()
*
* This function operates on every element (e) of class "serial", and initializes
* all the necessary HTML to construct the SerialPort module(s) as spec'ed.
*
* Note that each element (e) of class "serial" is expected to have a "data-value"
* attribute containing the same JSON-encoded parameters that the SerialPort constructor
* expects.
* This function operates on every HTML element of class "serial", extracting the
* JSON-encoded parameters for the C1PSerialPort constructor from the element's "data-value"
* attribute, invoking the constructor to create a C1PSerialPort component, and then binding
* any associated HTML controls to the new component.
*/
C1PSerialPort.init = function()
{

View file

@ -512,12 +512,10 @@ C1PVideo.prototype.updateWindow = function(col, row, b)
/**
* C1PVideo.init()
*
* This function operates on every element (e) of class "video", and initializes
* all the necessary HTML to construct every Video module as spec'ed.
*
* Note that each element (e) of class "video" is expected to have a "data-value"
* attribute containing the same JSON-encoded parameters that the Video constructor
* expects.
* This function operates on every HTML element of class "video", extracting the
* JSON-encoded parameters for the C1PVideo constructor from the element's "data-value"
* attribute, invoking the constructor to create a C1PVideo component, and then binding
* any associated HTML controls to the new component.
*/
C1PVideo.init = function()
{