Revert "[jsdoc]: fix formatOutputUInt function return type"

This reverts commit 3dc184260c.
This commit is contained in:
aliening 2023-11-12 10:44:14 +08:00
parent 3dc184260c
commit 8795a15186

View file

@ -1033,7 +1033,7 @@ var formatOutputInt = function (param) {
* *
* @method formatOutputUInt * @method formatOutputUInt
* @param {SolidityParam} * @param {SolidityParam}
* @returns {BigNumber} right-aligned output bytes formatted to uint * @returns {BigNumeber} right-aligned output bytes formatted to uint
*/ */
var formatOutputUInt = function (param) { var formatOutputUInt = function (param) {
var value = param.staticPart() || "0"; var value = param.staticPart() || "0";
@ -1192,7 +1192,7 @@ module.exports = SolidityTypeInt;
You should have received a copy of the GNU Lesser General Public License You should have received a copy of the GNU Lesser General Public License
along with web3.js. If not, see <http://www.gnu.org/licenses/>. along with web3.js. If not, see <http://www.gnu.org/licenses/>.
*/ */
/** /**
* @file param.js * @file param.js
* @author Marek Kotewicz <marek@ethdev.com> * @author Marek Kotewicz <marek@ethdev.com>
* @date 2015 * @date 2015
@ -1211,7 +1211,7 @@ var SolidityParam = function (value, offset) {
/** /**
* This method should be used to get length of params's dynamic part * This method should be used to get length of params's dynamic part
* *
* @method dynamicPartLength * @method dynamicPartLength
* @returns {Number} length of dynamic part (in bytes) * @returns {Number} length of dynamic part (in bytes)
*/ */
@ -1239,7 +1239,7 @@ SolidityParam.prototype.withOffset = function (offset) {
* @param {SolidityParam} result of combination * @param {SolidityParam} result of combination
*/ */
SolidityParam.prototype.combine = function (param) { SolidityParam.prototype.combine = function (param) {
return new SolidityParam(this.value + param.value); return new SolidityParam(this.value + param.value);
}; };
/** /**
@ -1271,8 +1271,8 @@ SolidityParam.prototype.offsetAsBytes = function () {
*/ */
SolidityParam.prototype.staticPart = function () { SolidityParam.prototype.staticPart = function () {
if (!this.isDynamic()) { if (!this.isDynamic()) {
return this.value; return this.value;
} }
return this.offsetAsBytes(); return this.offsetAsBytes();
}; };
@ -1304,7 +1304,7 @@ SolidityParam.prototype.encode = function () {
* @returns {String} * @returns {String}
*/ */
SolidityParam.encodeList = function (params) { SolidityParam.encodeList = function (params) {
// updating offsets // updating offsets
var totalOffset = params.length * 32; var totalOffset = params.length * 32;
var offsetParams = params.map(function (param) { var offsetParams = params.map(function (param) {
@ -1746,13 +1746,13 @@ if (typeof XMLHttpRequest === 'undefined') {
/** /**
* Utils * Utils
* *
* @module utils * @module utils
*/ */
/** /**
* Utility functions * Utility functions
* *
* @class [utils] config * @class [utils] config
* @constructor * @constructor
*/ */
@ -1819,7 +1819,7 @@ module.exports = {
You should have received a copy of the GNU Lesser General Public License You should have received a copy of the GNU Lesser General Public License
along with web3.js. If not, see <http://www.gnu.org/licenses/>. along with web3.js. If not, see <http://www.gnu.org/licenses/>.
*/ */
/** /**
* @file sha3.js * @file sha3.js
* @author Marek Kotewicz <marek@ethdev.com> * @author Marek Kotewicz <marek@ethdev.com>
* @date 2015 * @date 2015
@ -2739,7 +2739,7 @@ module.exports = AllSolidityEvents;
You should have received a copy of the GNU Lesser General Public License You should have received a copy of the GNU Lesser General Public License
along with web3.js. If not, see <http://www.gnu.org/licenses/>. along with web3.js. If not, see <http://www.gnu.org/licenses/>.
*/ */
/** /**
* @file batch.js * @file batch.js
* @author Marek Kotewicz <marek@ethdev.com> * @author Marek Kotewicz <marek@ethdev.com>
* @date 2015 * @date 2015
@ -2784,7 +2784,7 @@ Batch.prototype.execute = function () {
requests[index].callback(null, (requests[index].format ? requests[index].format(result.result) : result.result)); requests[index].callback(null, (requests[index].format ? requests[index].format(result.result) : result.result));
} }
}); });
}); });
}; };
module.exports = Batch; module.exports = Batch;
@ -2971,7 +2971,7 @@ var ContractFactory = function (eth, abi) {
*/ */
this.new = function () { this.new = function () {
/*jshint maxcomplexity: 7 */ /*jshint maxcomplexity: 7 */
var contract = new Contract(this.eth, this.abi); var contract = new Contract(this.eth, this.abi);
// parse arguments // parse arguments
@ -3119,7 +3119,7 @@ module.exports = ContractFactory;
You should have received a copy of the GNU Lesser General Public License You should have received a copy of the GNU Lesser General Public License
along with web3.js. If not, see <http://www.gnu.org/licenses/>. along with web3.js. If not, see <http://www.gnu.org/licenses/>.
*/ */
/** /**
* @file errors.js * @file errors.js
* @author Marek Kotewicz <marek@ethdev.com> * @author Marek Kotewicz <marek@ethdev.com>
* @date 2015 * @date 2015
@ -3394,7 +3394,7 @@ var extend = function (web3) {
} }
}; };
ex.formatters = formatters; ex.formatters = formatters;
ex.utils = utils; ex.utils = utils;
ex.Method = Method; ex.Method = Method;
ex.Property = Property; ex.Property = Property;
@ -4443,7 +4443,7 @@ module.exports = HttpProvider;
You should have received a copy of the GNU Lesser General Public License You should have received a copy of the GNU Lesser General Public License
along with web3.js. If not, see <http://www.gnu.org/licenses/>. along with web3.js. If not, see <http://www.gnu.org/licenses/>.
*/ */
/** /**
* @file iban.js * @file iban.js
* @author Marek Kotewicz <marek@ethdev.com> * @author Marek Kotewicz <marek@ethdev.com>
* @date 2015 * @date 2015
@ -4643,7 +4643,7 @@ Iban.prototype.address = function () {
var base36 = this._iban.substr(4); var base36 = this._iban.substr(4);
var asBn = new BigNumber(base36, 36); var asBn = new BigNumber(base36, 36);
return padLeft(asBn.toString(16), 20); return padLeft(asBn.toString(16), 20);
} }
return ''; return '';
}; };
@ -4688,7 +4688,7 @@ var IpcProvider = function (path, net) {
var _this = this; var _this = this;
this.responseCallbacks = {}; this.responseCallbacks = {};
this.path = path; this.path = path;
this.connection = net.connect({path: this.path}); this.connection = net.connect({path: this.path});
this.connection.on('error', function(e){ this.connection.on('error', function(e){
@ -4698,7 +4698,7 @@ var IpcProvider = function (path, net) {
this.connection.on('end', function(){ this.connection.on('end', function(){
_this._timeout(); _this._timeout();
}); });
// LISTEN FOR CONNECTION RESPONSES // LISTEN FOR CONNECTION RESPONSES
@ -4737,7 +4737,7 @@ Will parse the response and make an array out of it.
IpcProvider.prototype._parseResponse = function(data) { IpcProvider.prototype._parseResponse = function(data) {
var _this = this, var _this = this,
returnValues = []; returnValues = [];
// DE-CHUNKER // DE-CHUNKER
var dechunkedData = data var dechunkedData = data
.replace(/\}[\n\r]?\{/g,'}|--|{') // }{ .replace(/\}[\n\r]?\{/g,'}|--|{') // }{
@ -4841,7 +4841,7 @@ IpcProvider.prototype.send = function (payload) {
try { try {
result = JSON.parse(data); result = JSON.parse(data);
} catch(e) { } catch(e) {
throw errors.InvalidResponse(data); throw errors.InvalidResponse(data);
} }
return result; return result;
@ -5016,7 +5016,7 @@ Method.prototype.extractCallback = function (args) {
/** /**
* Should be called to check if the number of arguments is correct * Should be called to check if the number of arguments is correct
* *
* @method validateArgs * @method validateArgs
* @param {Array} arguments * @param {Array} arguments
* @throws {Error} if it is not * @throws {Error} if it is not
@ -5029,7 +5029,7 @@ Method.prototype.validateArgs = function (args) {
/** /**
* Should be called to format input args of method * Should be called to format input args of method
* *
* @method formatInput * @method formatInput
* @param {Array} * @param {Array}
* @return {Array} * @return {Array}
@ -5083,7 +5083,7 @@ Method.prototype.attachToObject = function (obj) {
obj[name[0]] = obj[name[0]] || {}; obj[name[0]] = obj[name[0]] || {};
obj[name[0]][name[1]] = func; obj[name[0]][name[1]] = func;
} else { } else {
obj[name[0]] = func; obj[name[0]] = func;
} }
}; };
@ -5146,8 +5146,8 @@ var DB = function (web3) {
this._requestManager = web3._requestManager; this._requestManager = web3._requestManager;
var self = this; var self = this;
methods().forEach(function(method) { methods().forEach(function(method) {
method.attachToObject(self); method.attachToObject(self);
method.setRequestManager(web3._requestManager); method.setRequestManager(web3._requestManager);
}); });
@ -5572,7 +5572,7 @@ var Net = function (web3) {
var self = this; var self = this;
properties().forEach(function(p) { properties().forEach(function(p) {
p.attachToObject(self); p.attachToObject(self);
p.setRequestManager(web3._requestManager); p.setRequestManager(web3._requestManager);
}); });
@ -6131,7 +6131,7 @@ module.exports = {
You should have received a copy of the GNU Lesser General Public License You should have received a copy of the GNU Lesser General Public License
along with web3.js. If not, see <http://www.gnu.org/licenses/>. along with web3.js. If not, see <http://www.gnu.org/licenses/>.
*/ */
/** /**
* @file namereg.js * @file namereg.js
* @author Marek Kotewicz <marek@ethdev.com> * @author Marek Kotewicz <marek@ethdev.com>
* @date 2015 * @date 2015
@ -6318,7 +6318,7 @@ module.exports = Property;
You should have received a copy of the GNU Lesser General Public License You should have received a copy of the GNU Lesser General Public License
along with web3.js. If not, see <http://www.gnu.org/licenses/>. along with web3.js. If not, see <http://www.gnu.org/licenses/>.
*/ */
/** /**
* @file requestmanager.js * @file requestmanager.js
* @author Jeffrey Wilcke <jeff@ethdev.com> * @author Jeffrey Wilcke <jeff@ethdev.com>
* @author Marek Kotewicz <marek@ethdev.com> * @author Marek Kotewicz <marek@ethdev.com>
@ -6385,7 +6385,7 @@ RequestManager.prototype.sendAsync = function (data, callback) {
if (err) { if (err) {
return callback(err); return callback(err);
} }
if (!Jsonrpc.isValidResponse(result)) { if (!Jsonrpc.isValidResponse(result)) {
return callback(errors.InvalidResponse(result)); return callback(errors.InvalidResponse(result));
} }
@ -6418,7 +6418,7 @@ RequestManager.prototype.sendBatch = function (data, callback) {
} }
callback(err, results); callback(err, results);
}); });
}; };
/** /**
@ -6522,7 +6522,7 @@ RequestManager.prototype.poll = function () {
} }
var payload = Jsonrpc.toBatchPayload(pollsData); var payload = Jsonrpc.toBatchPayload(pollsData);
// map the request id to they poll id // map the request id to they poll id
var pollsIdMap = {}; var pollsIdMap = {};
payload.forEach(function(load, index){ payload.forEach(function(load, index){
@ -6552,7 +6552,7 @@ RequestManager.prototype.poll = function () {
} else } else
return false; return false;
}).filter(function (result) { }).filter(function (result) {
return !!result; return !!result;
}).filter(function (result) { }).filter(function (result) {
var valid = Jsonrpc.isValidResponse(result); var valid = Jsonrpc.isValidResponse(result);
if (!valid) { if (!valid) {
@ -6627,16 +6627,16 @@ var pollSyncing = function(self) {
self.callbacks.forEach(function (callback) { self.callbacks.forEach(function (callback) {
if (self.lastSyncState !== sync) { if (self.lastSyncState !== sync) {
// call the callback with true first so the app can stop anything, before receiving the sync data // call the callback with true first so the app can stop anything, before receiving the sync data
if(!self.lastSyncState && utils.isObject(sync)) if(!self.lastSyncState && utils.isObject(sync))
callback(null, true); callback(null, true);
// call on the next CPU cycle, so the actions of the sync stop can be processes first // call on the next CPU cycle, so the actions of the sync stop can be processes first
setTimeout(function() { setTimeout(function() {
callback(null, sync); callback(null, sync);
}, 0); }, 0);
self.lastSyncState = sync; self.lastSyncState = sync;
} }
}); });
@ -6691,7 +6691,7 @@ module.exports = IsSyncing;
You should have received a copy of the GNU Lesser General Public License You should have received a copy of the GNU Lesser General Public License
along with web3.js. If not, see <http://www.gnu.org/licenses/>. along with web3.js. If not, see <http://www.gnu.org/licenses/>.
*/ */
/** /**
* @file transfer.js * @file transfer.js
* @author Marek Kotewicz <marek@ethdev.com> * @author Marek Kotewicz <marek@ethdev.com>
* @date 2015 * @date 2015
@ -6710,7 +6710,7 @@ var exchangeAbi = require('../contracts/SmartExchange.json');
* @param {Function} callback, callback * @param {Function} callback, callback
*/ */
var transfer = function (eth, from, to, value, callback) { var transfer = function (eth, from, to, value, callback) {
var iban = new Iban(to); var iban = new Iban(to);
if (!iban.isValid()) { if (!iban.isValid()) {
throw new Error('invalid iban address'); throw new Error('invalid iban address');
} }
@ -6718,7 +6718,7 @@ var transfer = function (eth, from, to, value, callback) {
if (iban.isDirect()) { if (iban.isDirect()) {
return transferToAddress(eth, from, iban.address(), value, callback); return transferToAddress(eth, from, iban.address(), value, callback);
} }
if (!callback) { if (!callback) {
var address = eth.icapNamereg().addr(iban.institution()); var address = eth.icapNamereg().addr(iban.institution());
return deposit(eth, from, address, value, iban.client()); return deposit(eth, from, address, value, iban.client());
@ -6727,7 +6727,7 @@ var transfer = function (eth, from, to, value, callback) {
eth.icapNamereg().addr(iban.institution(), function (err, address) { eth.icapNamereg().addr(iban.institution(), function (err, address) {
return deposit(eth, from, address, value, iban.client(), callback); return deposit(eth, from, address, value, iban.client(), callback);
}); });
}; };
/** /**