Răsfoiți Sursa

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

Piotrek Koszuliński 7 ani în urmă
părinte
comite
73cec7d2eb

+ 2 - 2
packages/ckeditor5-font/docs/api/font.md

@@ -10,8 +10,8 @@ This package implements the font family and font size features for CKEditor 5.
 
 ## Documentation
 
-See the {@link features/font Font feature} guide 
-with the corresponding {@link module:font/fontfamily~FontFamily} and {@link module:font/fontsize~FontSize} plugins documentation.
+See the {@link features/font Font feature} guide
+and {@link module:font/fontfamily~FontFamily} and {@link module:font/fontsize~FontSize} plugins documentation.
 
 ## Installation
 

+ 2 - 2
packages/ckeditor5-font/docs/features/font.md

@@ -216,7 +216,7 @@ The {@link module:font/fontfamily~FontFamily} plugin registers:
 	]
 	```
 
-	the `fontFamily` command will accept the corresponding strings as values:
+	the `'fontFamily'` command will accept the corresponding strings as values:
 
 	* `'Arial'`
 	* `'Courier New'`
@@ -227,7 +227,7 @@ The {@link module:font/fontfamily~FontFamily} plugin registers:
 	* `'Trebuchet MS'`
 	* `'Verdana'`
 
-	Note that passing an empty value will remove the `fontFamily` from the selection (`default`):
+	Note that passing an empty value will remove the `fontFamily` attribute from the selection (`default`):
 
 	```js
 	editor.execute( 'fontFamily' );

+ 4 - 2
packages/ckeditor5-font/src/font.js

@@ -13,11 +13,13 @@ import FontFamily from './fontfamily';
 import FontSize from './fontsize';
 
 /**
- * A plugin that enables (aggregates) a set of text styling features:
+ * A plugin that enables a set of text styling features:
+ *
  * * {@link module:font/fontsize~FontSize},
  * * {@link module:font/fontfamily~FontFamily}.
  *
- * For a detailed overview, check the {@glink features/font font feature} documentation.
+ * For a detailed overview, check the {@glink features/font Font feature} documentation
+ * and the {@glink api/font package page}.
  *
  * @extends module:core/plugin~Plugin
  */

+ 5 - 4
packages/ckeditor5-font/src/fontfamily.js

@@ -14,10 +14,11 @@ import FontFamilyUI from './fontfamily/fontfamilyui';
 /**
  * The font family plugin.
  *
- * It enables {@link module:font/fontfamily/fontfamilyediting~FontFamilyEditing} and
- * {@link module:font/fontfamily/fontfamilyui~FontFamilyUI} features in the editor.
+ * For a detailed overview, check the {@glink features/font font feature} documentatiom
+ * and the {@glink api/font package page}.
  *
- * For a detailed overview, check the {@glink features/font font feature} documentation.
+ * This is a "glue" plugin which loads the {@link module:font/fontfamily/fontfamilyediting~FontFamilyEditing} and
+ * {@link module:font/fontfamily/fontfamilyui~FontFamilyUI} features in the editor.
  *
  * @extends module:core/plugin~Plugin
  */
@@ -107,7 +108,7 @@ export default class FontFamily extends Plugin {
  *
  *		editor.execute( 'fontFamily', { value: 'Arial' } );
  *
- * Executing the `fontFamily` command without any value will remove the `fontFamily` attribute from the current selection.
+ * Executing the `'fontFamily'` command without any value will remove the `fontFamily` attribute from the current selection.
  *
  * @member {Array.<String|module:font/fontfamily~FontFamilyOption>} module:font/fontfamily~FontFamilyConfig#options
  */

+ 5 - 4
packages/ckeditor5-font/src/fontsize.js

@@ -14,10 +14,11 @@ import FontSizeUI from './fontsize/fontsizeui';
 /**
  * The font size plugin.
  *
- * It enables {@link module:font/fontsize/fontsizeediting~FontSizeEditing} and
- * {@link module:font/fontsize/fontsizeui~FontSizeUI} features in the editor.
+ * For a detailed overview, check the {@glink features/font font feature} documentation
+ * and the {@glink api/font package page}.
  *
- * For a detailed overview, check the {@glink features/font font feature} documentation.
+ * This is a "glue" plugin which loads the {@link module:font/fontsize/fontsizeediting~FontSizeEditing} and
+ * {@link module:font/fontsize/fontsizeui~FontSizeUI} features in the editor.
  *
  * @extends module:core/plugin~Plugin
  */
@@ -104,7 +105,7 @@ export default class FontSize extends Plugin {
  * 			options: [ 9, 10, 11, 12, 13, 14, 15 ]
  * 		};
  *
- * Font size can be applied using the command API. To do that, use the `fontSize` command and pass the desired font size as a `value`.
+ * Font size can be applied using the command API. To do that, use the `'fontSize'` command and pass the desired font size as a `value`.
  * For example, the following code will apply the `fontSize` attribute with the **tiny** value to the current selection:
  *
  *		editor.execute( 'fontSize', { value: 'tiny' } );