From 89957aed76917b0089b446cf241cef4a0e0df1a0 Mon Sep 17 00:00:00 2001 From: hacksalot Date: Tue, 2 Feb 2016 17:47:32 -0500 Subject: [PATCH] Scrub. Adding slightly heavier function-level comments as a start for API docs. --- src/verbs/verb.coffee | 9 ++++++--- 1 file changed, 6 insertions(+), 3 deletions(-) diff --git a/src/verbs/verb.coffee b/src/verbs/verb.coffee index 2559b37..436bee4 100644 --- a/src/verbs/verb.coffee +++ b/src/verbs/verb.coffee @@ -13,9 +13,12 @@ Promise = require 'pinkie-promise' ###* -An instantiation of a HackMyResume command. +An abstract invokable verb. +Provides base class functionality for verbs. Provide common services such as +error handling, event management, and promise support. @class Verb ### + module.exports = class Verb @@ -39,8 +42,7 @@ module.exports = class Verb ###* Forward subscriptions to the event emitter. ### - on: -> - @emitter.on.apply @emitter, arguments + on: -> @emitter.on.apply @emitter, arguments @@ -77,6 +79,7 @@ module.exports = class Verb + ###* Has an error occurred during this verb invocation? ### hasError: -> @errorCode || @errorObj