From cccb3766792f8ac3d6247028a084d6cb88544a89 Mon Sep 17 00:00:00 2001 From: Andrew Stewart Date: Tue, 14 Apr 2015 18:16:03 -0700 Subject: [PATCH] Consistent top-of-file doc blocks --- lib/adaptor.js | 4 ++-- lib/basestar.js | 4 ++-- lib/config.js | 2 +- lib/cylon.js | 2 +- lib/driver.js | 4 ++-- lib/initializer.js | 4 ++-- lib/io/digital-pin.js | 4 ++-- lib/io/utils.js | 8 ++++++++ lib/logger.js | 4 ++-- lib/logger/basic_logger.js | 8 ++++++++ lib/logger/null_logger.js | 8 ++++++++ lib/registry.js | 8 ++------ lib/robot.js | 4 ++-- lib/test/loopback.js | 2 +- lib/test/ping.js | 2 +- lib/test/test-adaptor.js | 2 +- lib/test/test-driver.js | 2 +- lib/utils/helpers.js | 10 ++++++++-- lib/utils/monkey-patches.js | 8 ++++++++ 19 files changed, 62 insertions(+), 28 deletions(-) diff --git a/lib/adaptor.js b/lib/adaptor.js index 2e2d03e..00d3dd3 100644 --- a/lib/adaptor.js +++ b/lib/adaptor.js @@ -1,5 +1,5 @@ -/* - * adaptor +/** + * Cylon.js - Adaptor base class * cylonjs.com * * Copyright (c) 2013-2015 The Hybrid Group diff --git a/lib/basestar.js b/lib/basestar.js index a26d7c6..085dc26 100644 --- a/lib/basestar.js +++ b/lib/basestar.js @@ -1,5 +1,5 @@ -/* - * basestar +/** + * Cylon.js - Basestar base class * cylonjs.com * * Copyright (c) 2013-2015 The Hybrid Group diff --git a/lib/config.js b/lib/config.js index 270afe5..3ce19a1 100644 --- a/lib/config.js +++ b/lib/config.js @@ -1,5 +1,5 @@ /* - * Cylon - Internal Configuration + * Cylon.js - Internal Configuration * cylonjs.com * * Copyright (c) 2013-2015 The Hybrid Group diff --git a/lib/cylon.js b/lib/cylon.js index a606b83..369373f 100644 --- a/lib/cylon.js +++ b/lib/cylon.js @@ -1,5 +1,5 @@ /* - * cylon + * Cylon.js - Master Control Program * cylonjs.com * * Copyright (c) 2013-2015 The Hybrid Group diff --git a/lib/driver.js b/lib/driver.js index 7b34109..2d9328d 100644 --- a/lib/driver.js +++ b/lib/driver.js @@ -1,5 +1,5 @@ -/* - * driver +/** + * Cylon.js - Driver base class * cylonjs.com * * Copyright (c) 2013-2015 The Hybrid Group diff --git a/lib/initializer.js b/lib/initializer.js index eb414c1..9c6b45e 100644 --- a/lib/initializer.js +++ b/lib/initializer.js @@ -1,5 +1,5 @@ -/* - * Device/Connection Initializer +/** + * Cylon.js - Adaptor/Driver initializer * cylonjs.com * * Copyright (c) 2013-2015 The Hybrid Group diff --git a/lib/io/digital-pin.js b/lib/io/digital-pin.js index 2350ce7..2f398a2 100644 --- a/lib/io/digital-pin.js +++ b/lib/io/digital-pin.js @@ -1,5 +1,5 @@ -/* - * Linux IO DigitalPin +/** + * Cylon.js - GPIO Digital Pin class * cylonjs.com * * Copyright (c) 2013-2015 The Hybrid Group diff --git a/lib/io/utils.js b/lib/io/utils.js index 85522cd..483f9f7 100644 --- a/lib/io/utils.js +++ b/lib/io/utils.js @@ -1,3 +1,11 @@ +/** + * Cylon.js - I/O Utils + * cylonjs.com + * + * Copyright (c) 2013-2015 The Hybrid Group + * Licensed under the Apache 2.0 license. +*/ + "use strict"; module.exports = { diff --git a/lib/logger.js b/lib/logger.js index 7ee376b..1d66323 100644 --- a/lib/logger.js +++ b/lib/logger.js @@ -1,5 +1,5 @@ -/* - * logger +/** + * Cylon.js - Logger * cylonjs.com * * Copyright (c) 2013-2015 The Hybrid Group diff --git a/lib/logger/basic_logger.js b/lib/logger/basic_logger.js index 46a6db5..8f7ea42 100644 --- a/lib/logger/basic_logger.js +++ b/lib/logger/basic_logger.js @@ -1,3 +1,11 @@ +/** + * Cylon.js - Basic Logger + * cylonjs.com + * + * Copyright (c) 2013-2015 The Hybrid Group + * Licensed under the Apache 2.0 license. +*/ + "use strict"; var getArgs = function(args) { diff --git a/lib/logger/null_logger.js b/lib/logger/null_logger.js index 0daadc8..d0b4e55 100644 --- a/lib/logger/null_logger.js +++ b/lib/logger/null_logger.js @@ -1,3 +1,11 @@ +/** + * Cylon.js - Null Logger + * cylonjs.com + * + * Copyright (c) 2013-2015 The Hybrid Group + * Licensed under the Apache 2.0 license. +*/ + "use strict"; // The NullLogger is designed for cases where you want absolutely nothing to diff --git a/lib/registry.js b/lib/registry.js index e64c264..4c72f7f 100644 --- a/lib/registry.js +++ b/lib/registry.js @@ -1,9 +1,5 @@ -/* - * Registry - * - * The Registry contains references to all Drivers and Adaptors Cylon is aware - * of, along with which module they live in (e.g. cylon-firmata). - * +/** + * Cylon.js - Module Registry * cylonjs.com * * Copyright (c) 2013-2015 The Hybrid Group diff --git a/lib/robot.js b/lib/robot.js index 33b7410..9256ea5 100644 --- a/lib/robot.js +++ b/lib/robot.js @@ -1,5 +1,5 @@ -/* - * robot +/** + * Cylon.js - Robot class * cylonjs.com * * Copyright (c) 2013-2015 The Hybrid Group diff --git a/lib/test/loopback.js b/lib/test/loopback.js index cea1a4f..cdcc884 100644 --- a/lib/test/loopback.js +++ b/lib/test/loopback.js @@ -1,5 +1,5 @@ /* - * Loopback adaptor + * Cylon.js - Loopback adaptor * cylonjs.com * * Copyright (c) 2013-2015 The Hybrid Group diff --git a/lib/test/ping.js b/lib/test/ping.js index 5958b64..1148b19 100644 --- a/lib/test/ping.js +++ b/lib/test/ping.js @@ -1,5 +1,5 @@ /* - * Ping driver + * Cylon.js - Ping driver * cylonjs.com * * Copyright (c) 2013-2015 The Hybrid Group diff --git a/lib/test/test-adaptor.js b/lib/test/test-adaptor.js index a305af4..021433f 100644 --- a/lib/test/test-adaptor.js +++ b/lib/test/test-adaptor.js @@ -1,5 +1,5 @@ /* - * Test adaptor + * Cylon.js - Test Adaptor * cylonjs.com * * Copyright (c) 2013-2015 The Hybrid Group diff --git a/lib/test/test-driver.js b/lib/test/test-driver.js index 907d106..16bf82a 100644 --- a/lib/test/test-driver.js +++ b/lib/test/test-driver.js @@ -1,5 +1,5 @@ /* - * Test driver + * Cylon.js - Test Driver * cylonjs.com * * Copyright (c) 2013-2015 The Hybrid Group diff --git a/lib/utils/helpers.js b/lib/utils/helpers.js index b84c4a1..b84135c 100644 --- a/lib/utils/helpers.js +++ b/lib/utils/helpers.js @@ -1,5 +1,11 @@ -// A collection of useful helper functions, used internally but not exported -// with the rest of Cylon. +/** + * Cylon.js - Helper Utilities + * cylonjs.com + * + * Copyright (c) 2013-2015 The Hybrid Group + * Licensed under the Apache 2.0 license. +*/ + "use strict"; var __slice = Array.prototype.slice; diff --git a/lib/utils/monkey-patches.js b/lib/utils/monkey-patches.js index 4ee914b..e38f310 100644 --- a/lib/utils/monkey-patches.js +++ b/lib/utils/monkey-patches.js @@ -1,3 +1,11 @@ +/** + * Cylon.js - Monkey Patches + * cylonjs.com + * + * Copyright (c) 2013-2015 The Hybrid Group + * Licensed under the Apache 2.0 license. +*/ + "use strict"; var max = Math.max,