Browse Source

API docs improvements.

Piotrek Koszuliński 9 years ago
parent
commit
16255a252c

+ 3 - 2
packages/ckeditor5-basic-styles/src/bold.js

@@ -10,8 +10,9 @@ import ButtonView from '../ui/button/buttonview.js';
 import Model from '../ui/model.js';
 
 /**
- * Bold feature. It requires {@link basic-styles.BoldEngine BoldEngine feature}.
- * This feature creates also a UI component (`bold` button) and registers <kbd>CTRL+B</kbd> keystroke.
+ * The Bold feature. It introduces the `bold` button and <kbd>CTRL+B</kbd> keystroke.
+ *
+ * It uses the {@link basic-styles.BoldEngine Bold engine feature}.
  *
  * @memberOf basic-styles
  * @extends ckeditor5.Feature

+ 4 - 2
packages/ckeditor5-basic-styles/src/boldengine.js

@@ -11,8 +11,10 @@ import AttributeCommand from '../command/attributecommand.js';
 const BOLD = 'bold';
 
 /**
- * Bold feature. It registers `bold` command and introduces `bold` attribute in the model, which renders to the view
- * as `<strong>` element.
+ * Bold engine feature.
+ *
+ * It registers `bold` command and introduces `bold` attribute in the model, which renders to the view
+ * as an `<strong>` element.
  *
  * @memberOf basic-styles
  * @extends ckeditor5.Feature

+ 3 - 2
packages/ckeditor5-basic-styles/src/italic.js

@@ -10,8 +10,9 @@ import ButtonView from '../ui/button/buttonview.js';
 import Model from '../ui/model.js';
 
 /**
- * Italic feature. It requires {@link basic-styles.ItalicEngine ItalicEngine feature}.
- * This feature creates also a UI component (`italic` button) and registers <kbd>CTRL+I</kbd> keystroke.
+ * The Italic feature. It introduces the `italic` button and <kbd>CTRL+I</kbd> keystroke.
+ *
+ * It uses the {@link basic-styles.ItalicEngine Italic engine feature}.
  *
  * @memberOf basic-styles
  * @extends ckeditor5.Feature

+ 4 - 2
packages/ckeditor5-basic-styles/src/italicengine.js

@@ -11,8 +11,10 @@ import AttributeCommand from '../command/attributecommand.js';
 const ITALIC = 'italic';
 
 /**
- * Italic feature. It registers `italic` command and introduces `italic` attribute in the model, which renders to the view
- * as `<em>` element.
+ * Italic engine feature.
+ *
+ * It registers the `italic` command and introduces the `italic` attribute in the model, which renders to the view
+ * as an`<em>` element.
  *
  * @memberOf basic-styles
  * @extends ckeditor5.Feature