From e3c0b123a0d1560e00449386c1a74f600d79efc2 Mon Sep 17 00:00:00 2001 From: Christopher Jeffrey Date: Tue, 7 Feb 2017 16:09:25 -0800 Subject: [PATCH] docs: build and expose scripterror properly. --- Makefile | 5 ++++- lib/http/request.js | 1 + lib/script/common.js | 2 +- package.json | 3 ++- 4 files changed, 8 insertions(+), 3 deletions(-) diff --git a/Makefile b/Makefile index cc51981c..6327dd04 100644 --- a/Makefile +++ b/Makefile @@ -6,7 +6,10 @@ all: clean: @npm run clean +docs: + @npm run docs + test: @npm test -.PHONY: all clean test +.PHONY: all clean docs test diff --git a/lib/http/request.js b/lib/http/request.js index 4bd3e532..26daba03 100644 --- a/lib/http/request.js +++ b/lib/http/request.js @@ -254,6 +254,7 @@ RequestOptions.prototype.toHTTP = function toHTTP() { /** * Request + * @alias module:http.Request * @constructor * @private * @param {Object} options diff --git a/lib/script/common.js b/lib/script/common.js index 25ed2804..38d522d6 100644 --- a/lib/script/common.js +++ b/lib/script/common.js @@ -769,7 +769,7 @@ exports.array = function(value) { /** * An error thrown from the scripting system, * potentially pertaining to Script execution. - * @exports ScriptError + * @alias module:script.ScriptError * @constructor * @extends Error * @param {String} code - Error code. diff --git a/package.json b/package.json index ab24fb5d..e62c4aca 100644 --- a/package.json +++ b/package.json @@ -60,7 +60,8 @@ "browserify": "browserify --im -o browser/bcoin.js lib/bcoin.js && browserify --im -o browser/bcoin-master.js lib/workers/master.js", "uglify": "uglifyjs -m -o browser/bcoin.min.js browser/bcoin.js && uglifyjs -m -o browser/bcoin-master.min.js browser/bcoin-master.js", "clean": "rm browser/bcoin.js browser/bcoin.min.js browser/bcoin-master.js browser/bcoin-master.min.js", - "lint": "jshint lib/ || exit 0" + "lint": "jshint lib/ || exit 0", + "docs": "jsdoc -c jsdoc.json" }, "browser": { "./lib/blockchain/layout": "./lib/blockchain/layout-browser.js",