Fix different typos and style issues (#1007)

IoT.js-DCO-1.0-Signed-off-by: Zsolt Borbély [email protected]

Author: Zsolt Borbély

cmake/jerry.cmake

@@ -83,7 +83,7 @@ if("${CMAKE_BUILD_TYPE}" STREQUAL "Debug")
   list(APPEND DEPS_LIB_JERRY_ARGS -DFEATURE_ERROR_MESSAGES=ON)
 endif()
 
-# Nuttx is not using the default port implementation of JerryScript
+# NuttX is not using the default port implementation of JerryScript
 if("${TARGET_OS}" MATCHES "NUTTX")
   list(APPEND DEPS_LIB_JERRY_ARGS -DJERRY_PORT_DEFAULT=OFF)
 else()

docs/api/IoT.js-API-ADC.md

@@ -28,8 +28,8 @@ Returns a new ADC object which can open an ADC pin.
 
 ### adc.open(configuration[, callback])
 * `configuration` {Object}
-  * `device` {string} mandatory configuration on Linux
-  * `pin` {int} mandatory configuration on NuttX
+  * `device` {string} Mandatory configuration on Linux.
+  * `pin` {int} Mandatory configuration on NuttX.
 * `callback` {Function}
   * `err`: {Error|null}
 * Returns: `AdcPin` {adc.AdcPin}
@@ -73,7 +73,7 @@ adc0.read(function(err, value) {
 
 
 ### adcpin.readSync()
-* Returns: `{int}` analog value
+* Returns: `{int}` Analog value.
 
 Reads the analog value from the pin synchronously.
 

docs/api/IoT.js-API-BLE.md

@@ -1,6 +1,6 @@
 ### Platform Support
 
-The following shows ble module APIs available for each platform.
+The following shows BLE module APIs available for each platform.
 
 |  | Linux<br/>(Ubuntu) | Raspbian<br/>(Raspberry Pi) | NuttX<br/>(STM32F4-Discovery) |
 | :---: | :---: | :---: | :---: |
@@ -56,12 +56,12 @@ ble.on('stateChange', function(state){
 ```
 
 ### ble.startAdvertising(name, serviceUuids[, callback])
-* `name` {string} - maximum 26 bytes
+* `name` {string} Maximum 26 bytes.
 * `serviceUuids` {Array[String]}
   * 1 128-bit service UUID
   * 1 128-bit service UUID + 2 16-bit service UUIDs
   * 7 16-bit service UUID
-* `callback` {Function} error handler
+* `callback` {Function} Error handler.
   * `error` {Error}
 
 Starts advertising.
@@ -80,15 +80,15 @@ ble.startAdvertising(name, serviceUuids[, callback(error)]);
 
 
 ### ble.stopAdvertising(callback)
-* `callback` {Function} error handler
+* `callback` {Function} Error handler.
   * `error` {Error}
 
 Stops advertising.
 
 
 ### ble.setServices(services[, callback])
 * `services` {Array[PrimaryService]}
-* `callback` {Function} error handler
+* `callback` {Function} Error handler.
   * `error` {Error}
 
 Sets the primary services available on the peripheral.
@@ -124,23 +124,23 @@ Characteristics are defined attribute types that contain a single logical value.
   * `secure` {Array[string]} Enables security for properties, can be a combination of 'read', 'write', 'writeWithoutResponse', 'notify' and 'indicate'.
   * `value` {Buffer}
   * `descriptors` {Array[Descriptor]}
-  * `onReadRequest` {Function} ead request handler (optional)
+  * `onReadRequest` {Function} Read request handler. (optional)
     * `offset` {number} (0x0000 - 0xffff)
     * `callback` {Function}
       * `result` {Characteristic.RESULT_*}
       * `data` {Buffer}
-  * `onWriteRequest` {Function} write request handler (optional)
+  * `onWriteRequest` {Function} Write request handler. (optional)
     * `data` {Buffer}
     * `offset` {number} (0x0000 - 0xffff)
     * `withoutResponse` {boolean}
     * `callback` {Function}
       * `result` {Characteristic.RESULT_*}
-  * `onSubscribe` {Function} notify/indicate subscribe handler (optional)
-    * `maxValueSize` {number} maximum data size
+  * `onSubscribe` {Function} Notify/indicate subscribe handler. (optional)
+    * `maxValueSize` {number} Maximum data size.
     * `updateValueCallback` {Function}
-  * `onUnsubscribe` {Function} notify/indicate unsubscribe handler (optional)
-  * `onNotify` {Function} notify sent handler (optional)
-  * `onIndicate` {Function} indicate confirmation received handler (optional)
+  * `onUnsubscribe` {Function} Notify/indicate unsubscribe handler. (optional)
+  * `onNotify` {Function} Notify sent handler. (optional)
+  * `onIndicate` {Function} Indicate confirmation received handler. (optional)
 Returns: {Characteristic}
 
 **Example**

docs/api/IoT.js-API-Buffer.md

@@ -423,7 +423,7 @@ console.log(buffer);
 
 ### buf.writeUInt8(value, offset[, noAssert])
 * `value` {integer} Number to be written into the buffer.
-* `offset' {integer} Start position of the writing.
+* `offset` {integer} Start position of the writing.
 * `noAssert` {boolean} Skip argument validation. **Default:** `false`
 * Returns: {number} Offset plus the number of bytes written.
 

docs/api/IoT.js-API-Events.md

@@ -8,9 +8,8 @@ The following shows Event module APIs available for each platform.
 | emitter.on | O | O | O |
 | emitter.emit | O | O | O |
 | emitter.once | O | O | O |
-| emitter.addListener | O | O | O |
 | emitter.removeListener | O | O | O |
-| emitter.removeAllListener | O | O | O |
+| emitter.removeAllListeners | O | O | O |
 
 
 # Events
@@ -19,7 +18,7 @@ IoT.js is based on event-driven programming where objects (called "emitters") pe
 
 # Class: EventEmitter
 
-The `events.EventEmitter` plays a role as base class for "emmitters".
+The `events.EventEmitter` plays a role as base class for "emitters".
 User application would not directly creates an instance of `EventEmitter` since `EventEmitter` is an abstract trait which defines its behavior and grants to sub-classes.
 
 ### new EventEmitter()
@@ -162,7 +161,7 @@ assert.equal(onceCnt, 1);
   * `args` {any}.
 * Returns `emitter` {events.EventEmitter}.
 
-Removes listener from the list of event listeners.
+Removes `listener` from the list of event listeners.
 
 If you add the same `listener` multiple times, this removes only one instance of them.
 
@@ -182,7 +181,7 @@ emitter.removeListener('event', listener);
 
 ```
 
-### emitter.removeAllListener([event])
+### emitter.removeAllListeners([event])
 * `event` {string} The name of the event.
 * Returns `emitter` {events.EventEmitter}.
 

docs/api/IoT.js-API-Process.md

@@ -19,7 +19,7 @@ As a global, it is always available to IoT.js applications without using `requir
 ### process.arch
 * {string}
 
-The `arch` proeprty returns the processor architercture identifier that the IoT.js process is currently running on.
+The `arch` property returns the processor architecture identifier that the IoT.js process is currently running on.
 For instance `'arm'`, `'ia32'`, `'x64'`, or `'unknown'`.
 
 ### process.argv
@@ -89,7 +89,7 @@ is currently running on. For instance `'linux'`, `'darwin'`, `'nuttx'`, `'tizenr
 * `path` {string} The path to change working directory to.
 
 The `chdir` method changes the current working directory of the IoT.js process or
-throes an exception if the operaion fails (for instance the `path` specified does not exist).
+throws an exception if the operation fails (for instance the `path` specified does not exist).
 
 **Example**
 
@@ -202,13 +202,13 @@ The `'uncaughtException'` event is emitted when an uncaught JavaScript exception
 way back to the event loop. By default, IoT.js handles such exceptions by printing it to `stderr` and exiting.
 Adding a handler for the `'uncaughtException'` event overrides the default behavior.
 
-The listener function is called with the `Error` obect passed as the only argument.
+The listener function is called with the `Error` object passed as the only argument.
 
 **Warning: Using the `'uncaughtException'` event correctly**
 
 This event is a crude mechanism for exception handling intended to be used only as a last resort.
 The event should not be used as an eqivalent to 'On Error Resume Next'. Unhandled exceptions inherently mean
-that a program is in an unknown state. Thus attempting to resume the application code withtout properly
+that a program is in an unknown state. Thus attempting to resume the application code without properly
 recovering from the exception can cause unforeseen/unpredictable issues.
 
 Only one exception thrown within the event handler will be caught and will immediately terminate the application.

docs/build/Build-for-NuttX.md

@@ -50,7 +50,7 @@ $ brew install gcc-arm-none-eabi libusb minicom
 
 To generate headers which are required to build IoT.js, for the first time, you need to build NuttX at least once. This time NuttX build will be failed. But don't worry at this time. After one execution, you don't need this sequence any more.
 
-#### Supported Nuttx version
+#### Supported NuttX version
 |Repository|Tag Name|
 |----------|:------:|
 | nuttx | nuttx-7.19 |

docs/help/API-document-sample.md

@@ -11,7 +11,7 @@
 
 The following shows `{Your_module_name}` module APIs available for each platform.
 
-|  | Linux<br/>(Ubuntu) | Raspbian<br/>(Raspberry Pi) | Nuttx<br/>(STM32F4-Discovery) |
+|  | Linux<br/>(Ubuntu) | Raspbian<br/>(Raspberry Pi) | NuttX<br/>(STM32F4-Discovery) |
 | :---: | :---: | :---: | :---: |
 | {functionName1} | O | O | O |
 | {functionName2} | O | O | O |

tools/build.py

@@ -206,15 +206,15 @@ def init_options():
 
 
 def adjust_options(options):
-    # First fix some option inconsistencies
+    # First fix some option inconsistencies.
     if options.target_os in ['nuttx', 'tizenrt']:
         options.buildlib = True
         if not options.sysroot:
             ex.fail('--sysroot needed for nuttx target')
 
         options.sysroot = fs.abspath(options.sysroot)
         if not fs.exists(options.sysroot):
-            ex.fail('Nuttx sysroot %s does not exist' % options.sysroot)
+            ex.fail('NuttX sysroot %s does not exist' % options.sysroot)
 
     if options.target_arch == 'x86':
         options.target_arch = 'i686'
@@ -232,7 +232,7 @@ def adjust_options(options):
     if options.iotjs_minimal_profile:
         options.no_check_test = True
 
-    # Then add calculated options
+    # Then add calculated options.
     options.host_tuple = '%s-%s' % (platform.arch(), platform.os())
     options.target_tuple = '%s-%s' % (options.target_arch, options.target_os)
 
@@ -254,7 +254,7 @@ def adjust_options(options):
     options.cmake_toolchain_file = cmake_path % options.target_tuple
     options.host_cmake_toolchain_file = cmake_path % options.host_tuple
 
-    # Specify the file of JerryScript profile
+    # Specify the file of JerryScript profile.
     options.jerry_profile = fs.join(path.JERRY_PROFILE_ROOT,
                                     options.jerry_profile + '.profile')
 
@@ -340,7 +340,7 @@ def get_on_off(boolean_value):
 def build_iotjs(options):
     print_progress('Build IoT.js')
 
-    # Set JerryScript cmake options.
+    # Set IoT.js cmake options.
     cmake_opt = [
         '-B%s' % options.build_root,
         '-H%s' % path.PROJECT_ROOT,
@@ -434,7 +434,7 @@ def run_checktest(options):
     if os.getenv('TRAVIS') == "true":
         checktest_quiet = 'no'
 
-    # iot.js executable
+    # IoT.js executable
     iotjs = fs.join(options.build_root, 'bin', 'iotjs')
     build_args = ['quiet=' + checktest_quiet]
     if options.iotjs_exclude_module:
@@ -481,7 +481,7 @@ def run_checktest(options):
 
     build_iotjs(options)
 
-    # Run tests
+    # Run tests.
     if not options.no_check_test:
         print_progress('Run tests')
         if options.buildlib: