search

ckeditor / ckeditor4

The best enterprise-grade WYSIWYG editor. Fully customizable with countless features and plugins.
https://ckeditor.com/ckeditor-4
Other
5.79k stars 2.48k forks source link

Method signatures for the `CKEDITOR.htmlDataProcessor` class don't match the `editor.dataProcessor` API #5387

Open Enquier opened 1 year ago

Enquier commented 1 year ago

Type of report

Docs

Provide a description of requested docs changes

The method signatures of the htmlDataProcesser were updated in 4.3.0, but the documentation still shows the older "backwards compatible" method signatures

See: https://ckeditor.com/docs/ckeditor4/latest/api/CKEDITOR_htmlDataProcessor.html#method-toHtml

which has the now "options" field instead populated by an array.

jacekbogdanski commented 1 year ago

Thanks @Enquier, indeed I see that these signatures don't match with the CKEDITOR.htmlDataProcessor class - https://github.com/ckeditor/ckeditor4/blob/b520aa2b406091dd378f77b5173a6249a2ddef38/core/htmldataprocessor.js#L211-L238 I'm wondering if these couldn't be inherited using the @inheritdoc feature.