1
0
mirror of https://github.com/JuanCanham/HackMyResume.git synced 2024-11-26 02:10:09 +00:00
Adding slightly heavier function-level comments as a start for API docs.
This commit is contained in:
hacksalot 2016-02-02 17:47:32 -05:00
parent 233025ddcc
commit 89957aed76

View File

@ -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 @class Verb
### ###
module.exports = class Verb module.exports = class Verb
@ -39,8 +42,7 @@ module.exports = class Verb
###* Forward subscriptions to the event emitter. ### ###* Forward subscriptions to the event emitter. ###
on: -> on: -> @emitter.on.apply @emitter, arguments
@emitter.on.apply @emitter, arguments
@ -77,6 +79,7 @@ module.exports = class Verb
###* Has an error occurred during this verb invocation? ###
hasError: -> @errorCode || @errorObj hasError: -> @errorCode || @errorObj