From 9f5244b761e42cf634f6a30e0b41f35886c4d563 Mon Sep 17 00:00:00 2001 From: Alan Date: Fri, 6 Oct 2023 15:59:31 +0800 Subject: [PATCH] better docs for form --- docs/json/roodata.json | 18 ++++++------------ docs/src/Roo_form_BasicForm.js.html | 4 ++-- docs/symbols/Roo.form.BasicForm.json | 9 +++------ docs/symbols/Roo.form.Form.json | 9 +++------ roojs-debug.js | 4 ++-- roojs-ui-debug.js | 4 ++-- 6 files changed, 18 insertions(+), 30 deletions(-) diff --git a/docs/json/roodata.json b/docs/json/roodata.json index 8c8c083a73..92fbbe73a8 100644 --- a/docs/json/roodata.json +++ b/docs/json/roodata.json @@ -218000,13 +218000,10 @@ { "name" : "errorMask", "type" : "Boolean", - "desc" : "e) default fal", + "desc" : "Should the form be masked (and the active element highlighted on error - default false", "memberOf" : "", "isOptional" : false, - "optvals" : [ - "true", - "false" - ] + "optvals" : [] }, { "name" : "errorReader", @@ -218035,7 +218032,7 @@ { "name" : "maskOffset", "type" : "Number", - "desc" : "Default 100", + "desc" : "space around form element to mask if there is an error Default 100", "memberOf" : "", "isOptional" : false, "optvals" : [] @@ -246461,13 +246458,10 @@ { "name" : "errorMask", "type" : "Boolean", - "desc" : "e) default fal", + "desc" : "Should the form be masked (and the active element highlighted on error - default false", "memberOf" : "Roo.form.BasicForm", "isOptional" : false, - "optvals" : [ - "true", - "false" - ] + "optvals" : [] }, { "name" : "errorReader", @@ -246532,7 +246526,7 @@ { "name" : "maskOffset", "type" : "Number", - "desc" : "Default 100", + "desc" : "space around form element to mask if there is an error Default 100", "memberOf" : "Roo.form.BasicForm", "isOptional" : false, "optvals" : [] diff --git a/docs/src/Roo_form_BasicForm.js.html b/docs/src/Roo_form_BasicForm.js.html index 3573f10ff8..d866c0598d 100644 --- a/docs/src/Roo_form_BasicForm.js.html +++ b/docs/src/Roo_form_BasicForm.js.html @@ -131,12 +131,12 @@ disableMask : false, /** - * @cfg {Boolean} errorMask (true|false) default false + * @cfg {Boolean} errorMask Should the form be masked (and the active element highlighted on error - default false */ errorMask : false, /** - * @cfg {Number} maskOffset Default 100 + * @cfg {Number} maskOffset space around form element to mask if there is an error Default 100 */ maskOffset : 100, diff --git a/docs/symbols/Roo.form.BasicForm.json b/docs/symbols/Roo.form.BasicForm.json index abd6d5f199..8b8ce01830 100644 --- a/docs/symbols/Roo.form.BasicForm.json +++ b/docs/symbols/Roo.form.BasicForm.json @@ -66,13 +66,10 @@ { "name" : "errorMask", "type" : "Boolean", - "desc" : "e) default fal", + "desc" : "Should the form be masked (and the active element highlighted on error - default false", "memberOf" : "", "isOptional" : false, - "optvals" : [ - "true", - "false" - ] + "optvals" : [] }, { "name" : "timeout", @@ -125,7 +122,7 @@ { "name" : "maskOffset", "type" : "Number", - "desc" : "Default 100", + "desc" : "space around form element to mask if there is an error Default 100", "memberOf" : "", "isOptional" : false, "optvals" : [] diff --git a/docs/symbols/Roo.form.Form.json b/docs/symbols/Roo.form.Form.json index 630f8e9208..b4372d9449 100644 --- a/docs/symbols/Roo.form.Form.json +++ b/docs/symbols/Roo.form.Form.json @@ -151,13 +151,10 @@ { "name" : "errorMask", "type" : "Boolean", - "desc" : "e) default fal", + "desc" : "Should the form be masked (and the active element highlighted on error - default false", "memberOf" : "Roo.form.BasicForm", "isOptional" : false, - "optvals" : [ - "true", - "false" - ] + "optvals" : [] }, { "name" : "itemCls", @@ -234,7 +231,7 @@ { "name" : "maskOffset", "type" : "Number", - "desc" : "Default 100", + "desc" : "space around form element to mask if there is an error Default 100", "memberOf" : "Roo.form.BasicForm", "isOptional" : false, "optvals" : [] diff --git a/roojs-debug.js b/roojs-debug.js index 79e7f849b3..ac6a13e229 100644 --- a/roojs-debug.js +++ b/roojs-debug.js @@ -54119,12 +54119,12 @@ Roo.extend(Roo.form.BasicForm, Roo.util.Observable, { disableMask : false, /** - * @cfg {Boolean} errorMask (true|false) default false + * @cfg {Boolean} errorMask Should the form be masked (and the active element highlighted on error - default false */ errorMask : false, /** - * @cfg {Number} maskOffset Default 100 + * @cfg {Number} maskOffset space around form element to mask if there is an error Default 100 */ maskOffset : 100, diff --git a/roojs-ui-debug.js b/roojs-ui-debug.js index eba4fa7a3b..dbba53aa63 100644 --- a/roojs-ui-debug.js +++ b/roojs-ui-debug.js @@ -29617,12 +29617,12 @@ Roo.extend(Roo.form.BasicForm, Roo.util.Observable, { disableMask : false, /** - * @cfg {Boolean} errorMask (true|false) default false + * @cfg {Boolean} errorMask Should the form be masked (and the active element highlighted on error - default false */ errorMask : false, /** - * @cfg {Number} maskOffset Default 100 + * @cfg {Number} maskOffset space around form element to mask if there is an error Default 100 */ maskOffset : 100, -- 2.39.2