From 31cdd01ee844be4b3d848d4cab8d52dcbf9795bd Mon Sep 17 00:00:00 2001 From: Artur Arseniev Date: Thu, 23 Dec 2021 13:47:09 +0100 Subject: [PATCH] Up sector doc --- docs/api/sector.md | 6 +++++- docs/api/style_manager.md | 2 ++ src/style_manager/model/Sector.js | 7 ++++--- 3 files changed, 11 insertions(+), 4 deletions(-) diff --git a/docs/api/sector.md b/docs/api/sector.md index 4d652fd7d..7d4ca2f64 100644 --- a/docs/api/sector.md +++ b/docs/api/sector.md @@ -9,7 +9,7 @@ * `id` **[String][1]** Sector id, eg. `typography` * `name` **[String][1]** Sector name, eg. `Typography` * `open` **[Boolean][2]?** Indicates the open state. -* `properties` **[Array][3]<[Object][4]>?** Indicate an array of Property defintions[Property]: property.html +* `properties` **[Array][3]<[Object][4]>?** Indicate an array of Property defintions. ### getId @@ -58,6 +58,10 @@ Get sector properties. Returns **[Array][3]<[Property]>** +## + +[Property]: property.html + [1]: https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String [2]: https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Boolean diff --git a/docs/api/style_manager.md b/docs/api/style_manager.md index 7589ddca0..0e6e1c9e4 100644 --- a/docs/api/style_manager.md +++ b/docs/api/style_manager.md @@ -40,6 +40,8 @@ const styleManager = editor.StyleManager; [Component]: component.html +[Property]: property.html + ## getConfig Get configuration object diff --git a/src/style_manager/model/Sector.js b/src/style_manager/model/Sector.js index 4d5b27741..faf75e996 100644 --- a/src/style_manager/model/Sector.js +++ b/src/style_manager/model/Sector.js @@ -8,9 +8,7 @@ import PropertyFactory from './PropertyFactory'; * @property {String} id Sector id, eg. `typography` * @property {String} name Sector name, eg. `Typography` * @property {Boolean} [open=true] Indicates the open state. - * @property {Array} [properties=[]] Indicate an array of Property defintions - * - * [Property]: property.html + * @property {Array} [properties=[]] Indicate an array of Property defintions. */ export default class Sector extends Model { defaults() { @@ -187,3 +185,6 @@ export default class Sector extends Model { return this.propFactory.build(buildP); } } +/** + * [Property]: property.html + */