Skip to content

Commit 8d968c6

Browse files
MauricioFauthMauricioFauth
committed
Fix some JS doc issues
Signed-off-by: Maurício Meneghini Fauth <mauricio@fauth.dev>
1 parent eb1ba4c commit 8d968c6

8 files changed

Lines changed: 13 additions & 14 deletions

File tree

‎js/src/database/events.js‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -27,7 +27,7 @@ const DatabaseEvents = {
2727
/**
2828
* Validate editor form fields.
2929
*
30-
* @return {bool}
30+
* @return {boolean}
3131
*/
3232
validate: function () {
3333
/**
@@ -507,7 +507,7 @@ const DatabaseEvents = {
507507
/**
508508
* Validate custom editor form fields.
509509
*
510-
* @return {bool}
510+
* @return {boolean}
511511
*/
512512
validateCustom: function () {
513513
/**

‎js/src/database/routines.js‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -37,7 +37,7 @@ const DatabaseRoutines = {
3737
/**
3838
* Validate editor form fields.
3939
*
40-
* @return {bool}
40+
* @return {boolean}
4141
*/
4242
validate: function () {
4343
/**
@@ -597,7 +597,7 @@ const DatabaseRoutines = {
597597
/**
598598
* Validate custom editor form fields.
599599
*
600-
* @return {bool}
600+
* @return {boolean}
601601
*/
602602
validateCustom: function () {
603603
/**

‎js/src/database/triggers.js‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -26,7 +26,7 @@ const DatabaseTriggers = {
2626
/**
2727
* Validate editor form fields.
2828
*
29-
* @return {bool}
29+
* @return {boolean}
3030
*/
3131
validate: function () {
3232
/**
@@ -61,7 +61,7 @@ const DatabaseTriggers = {
6161
* This function can be overridden by
6262
* other files in this folder
6363
*
64-
* @return {bool}
64+
* @return {boolean}
6565
*/
6666
validateCustom: function () {
6767
return true;

‎js/src/makegrid.js‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1459,7 +1459,7 @@ window.makeGrid = function (t, enableResize, enableReorder, enableVisib, enableG
14591459
/**
14601460
* Save edited cell, so it can be posted later.
14611461
*
1462-
* @return {bool}
1462+
* @return {boolean}
14631463
*/
14641464
saveEditedCell: function () {
14651465
/**

‎js/src/modules/functions.js‎

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -19,7 +19,6 @@ import isStorageSupported from './functions/isStorageSupported.js';
1919

2020
/**
2121
* General functions, usually for data manipulation pages.
22-
* @type {object}
2322
* @test-module Functions
2423
*/
2524
const Functions = {};
@@ -1688,7 +1687,7 @@ Functions.sqlPrettyPrint = function (string) {
16881687
* @param {Function} callbackFn callback to execute after user clicks on OK
16891688
* @param {Function} openCallback optional callback to run when dialog is shown
16901689
*
1691-
* @return {bool}
1690+
* @return {boolean}
16921691
*/
16931692
Functions.confirm = function (question, url, callbackFn, openCallback) {
16941693
var confirmState = CommonParams.get('confirm');

‎js/src/modules/navigation.js‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -337,7 +337,7 @@ Navigation.expandTreeNode = function ($expandElem, callback) {
337337
* Auto-scrolls the newly chosen database
338338
*
339339
* @param {object} $element The element to set to view
340-
* @param {bool} $forceToTop Whether to force scroll to top
340+
* @param {boolean} $forceToTop Whether to force scroll to top
341341
*
342342
*/
343343
Navigation.scrollToView = function ($element, $forceToTop) {
@@ -616,7 +616,7 @@ Navigation.ensureSettings = function (selflink) {
616616
*
617617
* @return {void}
618618
*/
619-
Navigation.reload = function (callback, paths) {
619+
Navigation.reload = function (callback = null, paths = null) {
620620
var params = {
621621
'reload': true,
622622
'no_debug': true,

‎js/src/setup/scripts.js‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -67,7 +67,7 @@ $(function () {
6767
* @param {String} id validator id
6868
* @param {object} values values hash {element1_id: value, ...}
6969
*
70-
* @return {bool|void}
70+
* @return {boolean|void}
7171
*/
7272
function ajaxValidate (parent, id, values) {
7373
var $parent = $(parent);

‎js/src/table/zoom_plot_jqplot.js‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -46,7 +46,7 @@ Array.min = function (array) {
4646
/**
4747
* Checks if a string contains only numeric value
4848
* @param {string} n (to be checked)
49-
* @return {bool}
49+
* @return {boolean}
5050
**/
5151
function isNumeric (n) {
5252
return ! isNaN(parseFloat(n)) && isFinite(n);
@@ -55,7 +55,7 @@ function isNumeric (n) {
5555
/**
5656
** Checks if an object is empty
5757
* @param {object} obj (to be checked)
58-
* @return {bool}
58+
* @return {boolean}
5959
**/
6060
function isEmpty (obj) {
6161
var name;

0 commit comments

Comments
 (0)