From d56e50e1664761a6db2bb8d599f6dac0eb2a3549 Mon Sep 17 00:00:00 2001 From: Christopher Jeffrey Date: Sun, 5 Feb 2017 18:17:49 -0800 Subject: [PATCH] script: docs for getters. --- lib/script/script.js | 13 +++++++------ lib/script/stack.js | 17 +++++++++-------- lib/script/witness.js | 17 +++++++++-------- 3 files changed, 25 insertions(+), 22 deletions(-) diff --git a/lib/script/script.js b/lib/script/script.js index ae3ff99c..21eeb47a 100644 --- a/lib/script/script.js +++ b/lib/script/script.js @@ -106,9 +106,9 @@ Script.typesByVal = common.typesByVal; /** * Getter to retrieve code length. - * @function - * @name length(get) - * @memberof Script# + * @name module:script.Script#length_getter + * @method + * @private * @returns {Number} */ @@ -118,9 +118,10 @@ Script.prototype.__defineGetter__('length', function() { /** * Setter to set code length. - * @function - * @name length(set) - * @memberof Script# + * @name module:script.Script#length_setter + * @method + * @private + * @param {Number} value * @returns {Number} */ diff --git a/lib/script/stack.js b/lib/script/stack.js index 6b0dcf99..476b2b29 100644 --- a/lib/script/stack.js +++ b/lib/script/stack.js @@ -26,10 +26,10 @@ function Stack(items) { } /** - * Getter to retrieve items length. - * @function - * @name length(get) - * @memberof Stack# + * Getter to retrieve stack items length. + * @name module:script.Stack#length_getter + * @method + * @private * @returns {Number} */ @@ -38,10 +38,11 @@ Stack.prototype.__defineGetter__('length', function() { }); /** - * Setter to set items length. - * @function - * @name length(set) - * @memberof Stack# + * Setter to set stack items length. + * @name module:script.Stack#length_setter + * @method + * @private + * @param {Number} value * @returns {Number} */ diff --git a/lib/script/witness.js b/lib/script/witness.js index 09c79331..f2a6f98f 100644 --- a/lib/script/witness.js +++ b/lib/script/witness.js @@ -45,10 +45,10 @@ function Witness(options) { } /** - * Getter to retrieve items length. - * @function - * @name length(get) - * @memberof Witness# + * Getter to retrieve witness vector length. + * @name module:script.Witness#length_getter + * @method + * @private * @returns {Number} */ @@ -57,10 +57,11 @@ Witness.prototype.__defineGetter__('length', function() { }); /** - * Setter to set items length. - * @function - * @name length(set) - * @memberof Witness# + * Setter to set witness vector length. + * @name module:script.Witness#length_setter + * @method + * @private + * @param {Number} value * @returns {Number} */