Parcourir la source

Docs: Fix documentation links and highlighters description.

Maciej Gołaszewski il y a 8 ans
Parent
commit
bde53b8682

+ 2 - 2
packages/ckeditor5-highlight/src/highlightcommand.js

@@ -10,7 +10,7 @@
 import Command from '@ckeditor/ckeditor5-core/src/command';
 
 /**
- * The highlight command. It is used by the {@link module:highlight/highlight~HighlightEditing highlight feature}
+ * The highlight command. It is used by the {@link module:highlight/highlightediting~HighlightEditing highlight feature}
  * to apply text highlighting.
  *
  * @extends module:core/command~Command
@@ -64,5 +64,5 @@ export default class HighlightCommand extends Command {
  *
  * @observable
  * @readonly
- * @member {undefined|String} HighlightCommand#value
+ * @member {undefined|String} module:highlight/highlightcommand~HighlightCommand#value
  */

+ 4 - 3
packages/ckeditor5-highlight/src/highlightediting.js

@@ -87,8 +87,9 @@ export default class HighlightEditing extends Plugin {
  * @property {String} class The class which is used to differentiate highlighters.
  * @property {String} title The user-readable title of the option.
  * @property {String} color Color used for highlighter. Should be coherent with CSS class definition.
- * @property {'marker'|'pen'} type The type of highlighter. Either "marker" - will use #color as background name
- * of the view element that will be used to represent the model element in the view.
+ * @property {'marker'|'pen'} type The type of highlighter:
+ * - "marker" - will use #color as background,
+ * - "pen" - will use #color as font color.
  */
 
 /**
@@ -96,7 +97,7 @@ export default class HighlightEditing extends Plugin {
  *
  * Read more in {@link module:highlight/highlightediting~HighlightEditingConfig}.
  *
- * @member {module:highlight/highlightediting~HighlightEditingConfig} module:core/editor/editorconfig~EditorConfig#alignment
+ * @member {module:highlight/highlightediting~HighlightEditingConfig} module:core/editor/editorconfig~EditorConfig#highlight
  */
 
 /**