Ensure all main files have headers

noflo · Nov 24, 2017 · 20d74ae · 20d74ae
1 parent 5abdfff
commit 20d74ae
Show file tree

Hide file tree

Showing 4 changed files with 17 additions and 8 deletions.
diff --git a/src/lib/Helpers.coffee b/src/lib/Helpers.coffee
@@ -7,6 +7,11 @@ platform = require './Platform'
 utils = require './Utils'
 debug = require('debug') 'noflo:helpers'
 
+# ## NoFlo WirePattern helper
+#
+# **Note:** WirePattern is no longer the recommended way to build
+# NoFlo components. Please use [Process API](https://noflojs.org/documentation/components/) instead.
+#
 # WirePattern makes your component collect data from several inports
 # and activates a handler `proc` only when a tuple from all of these
 # ports is complete. The signature of handler function is:

diff --git a/src/lib/InPort.coffee b/src/lib/InPort.coffee
@@ -1,12 +1,13 @@
 #     NoFlo - Flow-Based Programming for JavaScript
 #     (c) 2014-2017 Flowhub UG
 #     NoFlo may be freely distributed under the MIT license
-#
-# Input Port (inport) implementation for NoFlo components
 BasePort = require './BasePort'
 IP = require './IP'
-platform = require './Platform'
 
+# ## NoFlo inport
+#
+# Input Port (inport) implementation for NoFlo components. These
+# ports are the way a component receives Information Packets.
 class InPort extends BasePort
   constructor: (options = {}) ->
     options.control ?= false

diff --git a/src/lib/OutPort.coffee b/src/lib/OutPort.coffee
@@ -1,11 +1,13 @@
 #     NoFlo - Flow-Based Programming for JavaScript
 #     (c) 2014-2017 Flowhub UG
 #     NoFlo may be freely distributed under the MIT license
-#
-# Output Port (outport) implementation for NoFlo components
 BasePort = require './BasePort'
 IP = require './IP'
 
+# ## NoFlo outport
+#
+# Outport Port (outport) implementation for NoFlo components.
+# These ports are the way a component sends Information Packets.
 class OutPort extends BasePort
   constructor: (options = {}) ->
     options.scoped ?= true

diff --git a/src/lib/Ports.coffee b/src/lib/Ports.coffee
@@ -1,13 +1,14 @@
 #     NoFlo - Flow-Based Programming for JavaScript
 #     (c) 2014-2017 Flowhub UG
 #     NoFlo may be freely distributed under the MIT license
-#
-# Ports collection classes for NoFlo components
 {EventEmitter} = require 'events'
-
 InPort = require './InPort'
 OutPort = require './OutPort'
 
+# NoFlo ports collections
+#
+# Ports collection classes for NoFlo components. These are
+# used to hold a set of input or output ports of a component.
 class Ports extends EventEmitter
   model: InPort
   constructor: (ports) ->