瀏覽代碼

Docs: Improved links between API and guides. See ckeditor/ckeditor5#1090.

Piotrek Koszuliński 7 年之前
父節點
當前提交
7f5ab4563a

+ 3 - 1
packages/ckeditor5-basic-styles/docs/api/basic-styles.md

@@ -10,7 +10,9 @@ This package contains features allowing to apply basic text formatting such as b
 
 ## Documentation
 
-Check out the following plugins:
+See the {@link features/basic-styles Basic styles feature} guide.
+
+You can also check out the following plugins:
 
 * {@link module:basic-styles/bold~Bold}
 * {@link module:basic-styles/italic~Italic}

+ 4 - 1
packages/ckeditor5-basic-styles/src/bold.js

@@ -14,7 +14,10 @@ import BoldUI from './bold/boldui';
 /**
  * The bold feature.
  *
- * It loads the {@link module:basic-styles/bold/boldediting~BoldEditing bold editing feature}
+ * For a detailed overview check the {@glink features/basic-styles Basic styles feature documentation}
+ * and the {@glink api/basic-styles package page}.
+ *
+ * This is a "glue" plugin which loads the {@link module:basic-styles/bold/boldediting~BoldEditing bold editing feature}
  * and {@link module:basic-styles/bold/boldui~BoldUI bold UI feature}.
  *
  * @extends module:core/plugin~Plugin

+ 1 - 1
packages/ckeditor5-basic-styles/src/bold/boldediting.js

@@ -15,7 +15,7 @@ const BOLD = 'bold';
 /**
  * The bold editing feature.
  *
- * It registers the `bold` command and introduces the `bold` attribute in the model which renders to the view
+ * It registers the `'bold'` command and introduces the `bold` attribute in the model which renders to the view
  * as a `<strong>` element.
  *
  * @extends module:core/plugin~Plugin

+ 4 - 1
packages/ckeditor5-basic-styles/src/code.js

@@ -16,7 +16,10 @@ import '../theme/code.css';
 /**
  * The code feature.
  *
- * It loads the {@link module:basic-styles/code/codeediting~CodeEditing code editing feature}
+ * For a detailed overview check the {@glink features/basic-styles Basic styles feature documentation}
+ * and the {@glink api/basic-styles package page}.
+ *
+ * This is a "glue" plugin which loads the {@link module:basic-styles/code/codeediting~CodeEditing code editing feature}
  * and {@link module:basic-styles/code/codeui~CodeUI code UI feature}.
  *
  * @extends module:core/plugin~Plugin

+ 1 - 1
packages/ckeditor5-basic-styles/src/code/codeediting.js

@@ -15,7 +15,7 @@ const CODE = 'code';
 /**
  * The code editing feature.
  *
- * It registers the `code` command and introduces the `code` attribute in the model which renders to the view
+ * It registers the `'code'` command and introduces the `code` attribute in the model which renders to the view
  * as a `<code>` element.
  *
  * @extends module:core/plugin~Plugin

+ 4 - 1
packages/ckeditor5-basic-styles/src/italic.js

@@ -14,7 +14,10 @@ import ItalicUI from './italic/italicui';
 /**
  * The italic feature.
  *
- * It loads the {@link module:basic-styles/italic/italicediting~ItalicEditing} and
+ * For a detailed overview check the {@glink features/basic-styles Basic styles feature documentation}
+ * and the {@glink api/basic-styles package page}.
+ *
+ * This is a "glue" plugin which loads the {@link module:basic-styles/italic/italicediting~ItalicEditing} and
  * {@link module:basic-styles/italic/italicui~ItalicUI} plugins.
  *
  * @extends module:core/plugin~Plugin

+ 1 - 1
packages/ckeditor5-basic-styles/src/italic/italicediting.js

@@ -15,7 +15,7 @@ const ITALIC = 'italic';
 /**
  * The italic editing feature.
  *
- * It registers the `italic` command, the <kbd>Ctrl+I</kbd> keystroke and introduces the `italic` attribute in the model
+ * It registers the `'italic'` command, the <kbd>Ctrl+I</kbd> keystroke and introduces the `italic` attribute in the model
  * which renders to the view as an `<em>` element.
  *
  * @extends module:core/plugin~Plugin

+ 4 - 1
packages/ckeditor5-basic-styles/src/strikethrough.js

@@ -14,7 +14,10 @@ import StrikethroughUI from './strikethrough/strikethroughui';
 /**
  * The strikethrough feature.
  *
- * It loads the {@link module:basic-styles/strikethrough/strikethroughediting~StrikethroughEditing} and
+ * For a detailed overview check the {@glink features/basic-styles Basic styles feature documentation}
+ * and the {@glink api/basic-styles package page}.
+ *
+ * This is a "glue" plugin which loads the {@link module:basic-styles/strikethrough/strikethroughediting~StrikethroughEditing} and
  * {@link module:basic-styles/strikethrough/strikethroughui~StrikethroughUI} plugins.
  *
  * @extends module:core/plugin~Plugin

+ 1 - 1
packages/ckeditor5-basic-styles/src/strikethrough/strikethroughediting.js

@@ -15,7 +15,7 @@ const STRIKETHROUGH = 'strikethrough';
 /**
  * The strikethrough editing feature.
  *
- * It registers the `strikethrough` command, the <kbd>Ctrl+Shift+X</kbd> keystroke and introduces the
+ * It registers the `'strikethrough'` command, the <kbd>Ctrl+Shift+X</kbd> keystroke and introduces the
  * `strikethroughsthrough` attribute in the model which renders to the view
  * as a `<s>` element.
  *

+ 4 - 1
packages/ckeditor5-basic-styles/src/underline.js

@@ -14,7 +14,10 @@ import UnderlineUI from './underline/underlineui';
 /**
  * The underline feature.
  *
- * It loads the {@link module:basic-styles/underline/underlineediting~UnderlineEditing} and
+ * For a detailed overview check the {@glink features/basic-styles Basic styles feature documentation}
+ * and the {@glink api/basic-styles package page}.
+ *
+ * This is a "glue" plugin which loads the {@link module:basic-styles/underline/underlineediting~UnderlineEditing} and
  * {@link module:basic-styles/underline/underlineui~UnderlineUI} plugins.
  *
  * @extends module:core/plugin~Plugin

+ 1 - 1
packages/ckeditor5-basic-styles/src/underline/underlineediting.js

@@ -15,7 +15,7 @@ const UNDERLINE = 'underline';
 /**
  * The underline editing feature.
  *
- * It registers the `underline` command, the <kbd>Ctrl+U</kbd> keystroke
+ * It registers the `'underline'` command, the <kbd>Ctrl+U</kbd> keystroke
  * and introduces the `underline` attribute in the model which renders to the view as an `<u>` element.
  *
  * @extends module:core/plugin~Plugin