Fix autogenerated docs API

docs/api/canvas.md

@@ -30,9 +30,7 @@ canvas.setCoords(...);
 
 * `canvas:dragend` When a drag operation is ended, `DataTransfer` instance passed as an argument.
 
-`canvas:dragdata` On any dataTransfer parse, `DataTransfer` instance and the `result` are passed as arguments.
-By changing `result.content` you're able to customize what is dropped.
-------------------------------------------------------------------------
+* `canvas:dragdata` On any dataTransfer parse, `DataTransfer` instance and the `result` are passed as arguments. By changing `result.content` you're able to customize what is dropped.
 
 * `canvas:drop` Something is dropped in canvas, `DataTransfer` instance and the dropped model are passed as arguments.
 
@@ -92,9 +90,7 @@ editor.on('canvas:pointer', () => {
 });
 ```
 
-`canvas:refresh` Canvas was refreshed to update elements on top,
-like spots/tools (eg. via `editor.Canvas.refresh()` or on frame resize).
---------------------------------------------------------------------------
+* `canvas:refresh` Canvas was refreshed to update elements on top, like spots/tools (eg. via `editor.Canvas.refresh()` or on frame resize).
 
 ```javascript
 editor.on('canvas:refresh', (canvasRefreshOptions) => {
@@ -102,9 +98,7 @@ editor.on('canvas:refresh', (canvasRefreshOptions) => {
 });
 ```
 
-`canvas:frame:load` Frame loaded in canvas.
-The event is triggered right after iframe's `onload`.
--------------------------------------------------------
+* `canvas:frame:load` Frame loaded in canvas. The event is triggered right after iframe's `onload`.
 
 ```javascript
 editor.on('canvas:frame:load', ({ window }) => {
@@ -112,9 +106,7 @@ editor.on('canvas:frame:load', ({ window }) => {
 });
 ```
 
-`canvas:frame:load:head` Frame head loaded in canvas.
-The event is triggered right after iframe's finished to load the head elemenets (eg. scripts)
----------------------------------------------------------------------------------------------
+* `canvas:frame:load:head` Frame head loaded in canvas. The event is triggered right after iframe's finished to load the head elemenets (eg. scripts)
 
 ```javascript
 editor.on('canvas:frame:load:head', ({ window }) => {
@@ -122,9 +114,7 @@ editor.on('canvas:frame:load:head', ({ window }) => {
 });
 ```
 
-`canvas:frame:load:body` Frame body loaded in canvas.
-The event is triggered when the body is rendered with components.
------------------------------------------------------------------
+* `canvas:frame:load:body` Frame body loaded in canvas. The event is triggered when the body is rendered with components.
 
 ```javascript
 editor.on('canvas:frame:load:body', ({ window }) => {

docs/api/commands.md

@@ -32,19 +32,19 @@ editor.on('command:run', ({ id, result, options }) => {
 });
 ```
 
-* `command:run:COMMAND\_ID` Triggered on run of a specific command.
+* `command:run:COMMAND-ID` Triggered on run of a specific command.
 
 ```javascript
 editor.on('command:run:my-command', ({ result, options }) => { ... });
 ```
 
-* `command:run:before:COMMAND\_ID` Triggered before the command is called.
+* `command:run:before:COMMAND-ID` Triggered before the command is called.
 
 ```javascript
 editor.on('command:run:before:my-command', ({ options }) => { ... });
 ```
 
-* `command:abort:COMMAND\_ID` Triggered when the command execution is aborted.
+* `command:abort:COMMAND-ID` Triggered when the command execution is aborted.
 
 ```javascript
 editor.on('command:abort:my-command', ({ options }) => { ... });
@@ -65,13 +65,13 @@ editor.on('command:stop', ({ id, result, options }) => {
 });
 ```
 
-* `command:stop:COMMAND\_ID` Triggered on stop of a specific command.
+* `command:stop:COMMAND-ID` Triggered on stop of a specific command.
 
 ```javascript
 editor.on('command:run:my-command', ({ result, options }) => { ... });
 ```
 
-* `command:stop:before:COMMAND\_ID` Triggered before the command is called to stop.
+* `command:stop:before:COMMAND-ID` Triggered before the command is called to stop.
 
 ```javascript
 editor.on('command:stop:before:my-command', ({ options }) => { ... });

docs/api/components.md

@@ -48,20 +48,14 @@ cmp.addType(...);
 ## Methods
 
 *   [getWrapper][2]
-
 *   [getComponents][3]
-
 *   [addComponent][4]
-
 *   [clear][5]
-
 *   [addType][6]
-
 *   [getType][7]
-
 *   [getTypes][8]
 
-*   [Component]: component.html
+[Component]: component.html
 
 ## getWrapper
 

docs/api/storage_manager.md

@@ -32,9 +32,7 @@ editor.on('storage:start', (type) => {
 });
 ```
 
-`storage:start:store` Storage store request start.
-The project JSON object to store is passed as an argument (which you can edit).
--------------------------------------------------------------------------------
+* `storage:start:store` Storage store request start. The project JSON object to store is passed as an argument (which you can edit).
 
 ```javascript
 editor.on('storage:start:store', (data) => {
@@ -50,9 +48,7 @@ editor.on('storage:start:load', () => {
 });
 ```
 
-`storage:load` Storage loaded the project.
-The loaded project is passed as an argument.
---------------------------------------------
+* `storage:load` Storage loaded the project. The loaded project is passed as an argument.
 
 ```javascript
 editor.on('storage:load', (data, res) => {
@@ -60,9 +56,7 @@ editor.on('storage:load', (data, res) => {
 });
 ```
 
-`storage:store` Storage stored the project.
-The stored project is passed as an argument.
---------------------------------------------
+* `storage:store` Storage stored the project. The stored project is passed as an argument.
 
 ```javascript
 editor.on('storage:store', (data, res) => {
@@ -70,9 +64,7 @@ editor.on('storage:store', (data, res) => {
 });
 ```
 
-`storage:after` Storage request completed.
-Triggered right after `storage:load`/`storage:store`.
----------------------------------------------------------
+* `storage:after` Storage request completed. Triggered right after `storage:load`/`storage:store`.
 
 ```javascript
 editor.on('storage:after', (type) => {
@@ -80,9 +72,7 @@ editor.on('storage:after', (type) => {
 });
 ```
 
-`storage:end` Storage request ended.
-This event triggers also in case of errors.
--------------------------------------------
+* `storage:end` Storage request ended. This event triggers also in case of errors.
 
 ```javascript
 editor.on('storage:end', (type) => {
@@ -90,9 +80,7 @@ editor.on('storage:end', (type) => {
 });
 ```
 
-`storage:end:store` Storage store request ended.
-This event triggers also in case of errors.
--------------------------------------------
+* `storage:end:store` Storage store request ended. This event triggers also in case of errors.
 
 ```javascript
 editor.on('storage:end:store', () => {
@@ -100,9 +88,7 @@ editor.on('storage:end:store', () => {
 });
 ```
 
-`storage:end:load` Storage load request ended.
-This event triggers also in case of errors.
--------------------------------------------
+* `storage:end:load` Storage load request ended. This event triggers also in case of errors.
 
 ```javascript
 editor.on('storage:end:load', () => {

packages/core/src/canvas/types.ts

@@ -36,8 +36,7 @@ export enum CanvasEvents {
   dragEnd = 'canvas:dragend',
 
   /**
-   * @event `canvas:dragdata` On any dataTransfer parse, `DataTransfer` instance and the `result` are passed as arguments.
-   * By changing `result.content` you're able to customize what is dropped.
+   * @event `canvas:dragdata` On any dataTransfer parse, `DataTransfer` instance and the `result` are passed as arguments. By changing `result.content` you're able to customize what is dropped.
    */
   dragData = 'canvas:dragdata',
 
@@ -110,8 +109,7 @@ export enum CanvasEvents {
   pointer = 'canvas:pointer',
 
   /**
-   * @event `canvas:refresh` Canvas was refreshed to update elements on top,
-   * like spots/tools (eg. via `editor.Canvas.refresh()` or on frame resize).
+   * @event `canvas:refresh` Canvas was refreshed to update elements on top, like spots/tools (eg. via `editor.Canvas.refresh()` or on frame resize).
    * @example
    * editor.on('canvas:refresh', (canvasRefreshOptions) => {
    *  console.log('Canvas refreshed with options:', canvasRefreshOptions);
@@ -120,8 +118,7 @@ export enum CanvasEvents {
   refresh = 'canvas:refresh',
 
   /**
-   * @event `canvas:frame:load` Frame loaded in canvas.
-   * The event is triggered right after iframe's `onload`.
+   * @event `canvas:frame:load` Frame loaded in canvas. The event is triggered right after iframe's `onload`.
    * @example
    * editor.on('canvas:frame:load', ({ window }) => {
    *  console.log('Frame loaded', window);
@@ -130,8 +127,7 @@ export enum CanvasEvents {
   frameLoad = 'canvas:frame:load',
 
   /**
-   * @event `canvas:frame:load:head` Frame head loaded in canvas.
-   * The event is triggered right after iframe's finished to load the head elemenets (eg. scripts)
+   * @event `canvas:frame:load:head` Frame head loaded in canvas. The event is triggered right after iframe's finished to load the head elemenets (eg. scripts)
    * @example
    * editor.on('canvas:frame:load:head', ({ window }) => {
    *  console.log('Frame head loaded', window);
@@ -140,8 +136,7 @@ export enum CanvasEvents {
   frameLoadHead = 'canvas:frame:load:head',
 
   /**
-   * @event `canvas:frame:load:body` Frame body loaded in canvas.
-   * The event is triggered when the body is rendered with components.
+   * @event `canvas:frame:load:body` Frame body loaded in canvas. The event is triggered when the body is rendered with components.
    * @example
    * editor.on('canvas:frame:load:body', ({ window }) => {
    *  console.log('Frame completed the body render', window);

packages/core/src/commands/types.ts

@@ -11,7 +11,7 @@ export enum CommandsEvents {
   _run = 'run',
 
   /**
-   * @event `command:run:COMMAND_ID` Triggered on run of a specific command.
+   * @event `command:run:COMMAND-ID` Triggered on run of a specific command.
    * @example
    * editor.on('command:run:my-command', ({ result, options }) => { ... });
    */
@@ -19,14 +19,14 @@ export enum CommandsEvents {
   _runCommand = 'run:',
 
   /**
-   * @event `command:run:before:COMMAND_ID` Triggered before the command is called.
+   * @event `command:run:before:COMMAND-ID` Triggered before the command is called.
    * @example
    * editor.on('command:run:before:my-command', ({ options }) => { ... });
    */
   runBeforeCommand = 'command:run:before:',
 
   /**
-   * @event `command:abort:COMMAND_ID` Triggered when the command execution is aborted.
+   * @event `command:abort:COMMAND-ID` Triggered when the command execution is aborted.
    * @example
    * editor.on('command:abort:my-command', ({ options }) => { ... });
    *
@@ -51,7 +51,7 @@ export enum CommandsEvents {
   _stop = 'stop',
 
   /**
-   * @event `command:stop:COMMAND_ID` Triggered on stop of a specific command.
+   * @event `command:stop:COMMAND-ID` Triggered on stop of a specific command.
    * @example
    * editor.on('command:run:my-command', ({ result, options }) => { ... });
    */
@@ -59,7 +59,7 @@ export enum CommandsEvents {
   _stopCommand = 'stop:',
 
   /**
-   * @event `command:stop:before:COMMAND_ID` Triggered before the command is called to stop.
+   * @event `command:stop:before:COMMAND-ID` Triggered before the command is called to stop.
    * @example
    * editor.on('command:stop:before:my-command', ({ options }) => { ... });
    */

packages/core/src/dom_components/index.ts

@@ -49,7 +49,7 @@
  * * [getType](#gettype)
  * * [getTypes](#gettypes)
  *
- * * [Component]: component.html
+ * [Component]: component.html
  *
  * @module Components
  */

packages/core/src/storage_manager/types.ts

@@ -10,8 +10,7 @@ export enum StorageEvents {
   start = 'storage:start',
 
   /**
-   * @event `storage:start:store` Storage store request start.
-   * The project JSON object to store is passed as an argument (which you can edit).
+   * @event `storage:start:store` Storage store request start. The project JSON object to store is passed as an argument (which you can edit).
    * @example
    * editor.on('storage:start:store', (data) => {
    *  console.log('Storage start store');
@@ -29,8 +28,7 @@ export enum StorageEvents {
   startLoad = 'storage:start:load',
 
   /**
-   * @event `storage:load` Storage loaded the project.
-   * The loaded project is passed as an argument.
+   * @event `storage:load` Storage loaded the project. The loaded project is passed as an argument.
    * @example
    * editor.on('storage:load', (data, res) => {
    *  console.log('Storage loaded the project');
@@ -39,8 +37,7 @@ export enum StorageEvents {
   load = 'storage:load',
 
   /**
-   * @event `storage:store` Storage stored the project.
-   * The stored project is passed as an argument.
+   * @event `storage:store` Storage stored the project. The stored project is passed as an argument.
    * @example
    * editor.on('storage:store', (data, res) => {
    *  console.log('Storage stored the project');
@@ -49,8 +46,7 @@ export enum StorageEvents {
   store = 'storage:store',
 
   /**
-   * @event `storage:after` Storage request completed.
-   * Triggered right after `storage:load`/`storage:store`.
+   * @event `storage:after` Storage request completed. Triggered right after `storage:load`/`storage:store`.
    * @example
    * editor.on('storage:after', (type) => {
    *  console.log('Storage request completed');
@@ -61,8 +57,7 @@ export enum StorageEvents {
   afterLoad = 'storage:after:load',
 
   /**
-   * @event `storage:end` Storage request ended.
-   * This event triggers also in case of errors.
+   * @event `storage:end` Storage request ended. This event triggers also in case of errors.
    * @example
    * editor.on('storage:end', (type) => {
    *  console.log('Storage request ended');
@@ -71,8 +66,7 @@ export enum StorageEvents {
   end = 'storage:end',
 
   /**
-   * @event `storage:end:store` Storage store request ended.
-   * This event triggers also in case of errors.
+   * @event `storage:end:store` Storage store request ended. This event triggers also in case of errors.
    * @example
    * editor.on('storage:end:store', () => {
    *  console.log('Storage store request ended');
@@ -81,8 +75,7 @@ export enum StorageEvents {
   endStore = 'storage:end:store',
 
   /**
-   * @event `storage:end:load` Storage load request ended.
-   * This event triggers also in case of errors.
+   * @event `storage:end:load` Storage load request ended. This event triggers also in case of errors.
    * @example
    * editor.on('storage:end:load', () => {
    *  console.log('Storage load request ended');