Opened 13 years ago
Closed 13 years ago
#9824 closed Bug (fixed)
Fix events' documentation
| Reported by: | Piotrek Koszuliński | Owned by: | Piotrek Koszuliński |
|---|---|---|---|
| Priority: | Normal | Milestone: | |
| Component: | Documentation & Samples | Version: | 4.0 |
| Keywords: | Cc: |
Description
Some of them were incorrectly documented in v3 and after porting docs to JSDuck they still are.
For example:
/**
* Internal event to perform the {@link #method-insertHtml} call.
*
* @event insertHtml
* @param {CKEDITOR.editor} editor This editor instance.
* @param {Object} data
* @param {String} data.mode Mode in which data is inserted (see {@link #method-insertHtml}).
* @param {String} data.dataValue The HTML to insert.
*/
/**
* Internal event to perform the {@link #method-insertText} call.
*
* @event insertText
* @param {CKEDITOR.editor} editor This editor instance.
* @param {String} text The text to insert.
*/
/**
* Internal event to perform the {@link #method-insertElement} call.
*
* @event insertElement
* @param {CKEDITOR.editor} editor This editor instance.
* @param {CKEDITOR.dom.element} element The element to insert.
*/
Only first event is correctly documented. Next two have broken params descriptions - there's evt.data passed in both situations, not evt.element and evt.text.
Change History (2)
comment:1 Changed 13 years ago by
| Owner: | set to Piotrek Koszuliński |
|---|---|
| Status: | new → assigned |
comment:2 Changed 13 years ago by
| Resolution: | → fixed |
|---|---|
| Status: | assigned → closed |

Fixed with git:526aa73.