Browse Source

API docs corrections for basic styles.

Anna Tomanek 9 years ago
parent
commit
bf5bed2725

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

@@ -10,9 +10,9 @@ import ButtonView from '../ui/button/buttonview.js';
 import Model from '../ui/model.js';
 
 /**
- * The Bold feature. It introduces the `bold` button and <kbd>CTRL+B</kbd> keystroke.
+ * The bold feature. It introduces the Bold button and the <kbd>Ctrl+B</kbd> keystroke.
  *
- * It uses the {@link basic-styles.BoldEngine Bold engine feature}.
+ * It uses the {@link basic-styles.BoldEngine bold engine feature}.
  *
  * @memberOf basic-styles
  * @extends core.Feature
@@ -50,7 +50,7 @@ export default class Bold extends Feature {
 		// Add bold button to feature components.
 		editor.ui.featureComponents.add( 'bold', ButtonController, ButtonView, buttonModel );
 
-		// Set the CTRL+B keystroke.
+		// Set the Ctrl+B keystroke.
 		editor.keystrokes.set( 'CTRL+B', 'bold' );
 	}
 }

+ 3 - 3
packages/ckeditor5-basic-styles/src/boldengine.js

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

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

@@ -10,9 +10,9 @@ import ButtonView from '../ui/button/buttonview.js';
 import Model from '../ui/model.js';
 
 /**
- * The Italic feature. It introduces the `italic` button and <kbd>CTRL+I</kbd> keystroke.
+ * The italic feature. It introduces the Italic button and the <kbd>Ctrl+I</kbd> keystroke.
  *
- * It uses the {@link basic-styles.ItalicEngine Italic engine feature}.
+ * It uses the {@link basic-styles.ItalicEngine italic engine feature}.
  *
  * @memberOf basic-styles
  * @extends core.Feature
@@ -50,7 +50,7 @@ export default class Italic extends Feature {
 		// Add bold button to feature components.
 		editor.ui.featureComponents.add( 'italic', ButtonController, ButtonView, buttonModel );
 
-		// Set the CTRL+I keystroke.
+		// Set the Ctrl+I keystroke.
 		editor.keystrokes.set( 'CTRL+I', 'italic' );
 	}
 }

+ 3 - 3
packages/ckeditor5-basic-styles/src/italicengine.js

@@ -11,10 +11,10 @@ import AttributeCommand from '../core/command/attributecommand.js';
 const ITALIC = 'italic';
 
 /**
- * Italic engine feature.
+ * The 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.
+ * 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 core.Feature