fix missing jsdoc (#406)

* fix missing jsdoc

* add a few words about save and render functions
This commit is contained in:
Taly 2018-08-05 16:00:54 +03:00 committed by GitHub
parent 87ed7ec0ee
commit a7ebbae7fd
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
4 changed files with 56 additions and 93 deletions

File diff suppressed because one or more lines are too long

File diff suppressed because one or more lines are too long

View file

@ -31,8 +31,12 @@ constructor({data, config, api}) {
### render()
Method that returns Tool's element {HTMLElement} that will be placed into Editor.
### save()
Process Tool's element created by `render()` function in DOM and return Block's data.
### validate() _optional_
### merge() _optional_

View file

@ -1,44 +1,3 @@
/**
* Codex Editor
*
* Short Description (_눈;)
* @version 2.0.0
*
* How to start?
* Example:
* new CodexEditor({
* holderId : 'codex-editor',
* initialBlock : 'text',
* placeholder : 'Write your story....',
* tools: {
* quote: Quote,
* anotherTool : AnotherTool
* },
* toolsConfig: {
* quote: {
* iconClassname : 'quote-icon',
* displayInToolbox : true,
* enableLineBreaks : true
* },
* anotherTool: {
* iconClassname : 'tool-icon'
* }
* }
* });
*
* - tools is an object: {
* pluginName: PluginClass,
* .....
* }
* - toolsConfig is an additional configuration that uses Codex Editor API
* iconClassname - CSS classname of toolbox icon
* displayInToolbox - if you want to see your Tool in toolbox hided in "plus" button, than set "True". By default : "False"
* enableLineBreaks - by default enter creates new block that set as initialblock, but if you set this property "True", enter will break the lines in current block
*
* @author CodeX-Team <https://ifmo.su>
*
*/
'use strict';
/**
@ -49,6 +8,14 @@ import 'babel-polyfill';
import 'components/polyfills';
import Core from './components/core';
/**
* Codex Editor
*
* Short Description (_눈;)
* @version 2.0
*
* @author CodeX-Team <https://ifmo.su>
*/
export default class CodexEditor {
/** Editor version */
static get version() {