ソースを参照

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

Piotrek Koszuliński 7 年 前
コミット
fc68b6c25e

+ 4 - 1
packages/ckeditor5-heading/docs/api/heading.md

@@ -10,7 +10,10 @@ This package implements the headings feature for CKEditor 5.
 
 ## Documentation
 
-See the {@link features/headings Headings feature} guide and the {@link module:heading/heading~Heading} plugin documentation.
+See the {@link features/headings Headings feature} guide and the documentation of the following plugins:
+
+* {@link module:heading/heading~Heading},
+* {@link module:heading/headingbuttonsui~HeadingButtonsUI}
 
 ## Installation
 

+ 2 - 1
packages/ckeditor5-heading/docs/features/headings.md

@@ -1,8 +1,9 @@
 ---
-title: Headings
 category: features
 ---
 
+# Headings
+
 {@snippet build-classic-source}
 
 The {@link module:heading/heading~Heading} feature enables support for headings.

+ 5 - 4
packages/ckeditor5-heading/src/heading.js

@@ -16,10 +16,11 @@ import '../theme/heading.css';
 /**
  * The headings feature.
  *
- * It loads the {@link module:heading/headingediting~HeadingEditing heading editing feature}
- * and {@link module:heading/headingui~HeadingUI heading UI feature}.
+ * For a detailed overview, check the {@glink features/headings Headings feature documentation}
+ * and the {@glink api/heading package page}.
  *
- * For a detailed overview, check the {@glink features/headings Headings feature documentation}.
+ * This is a "glue" plugin which loads the {@link module:heading/headingediting~HeadingEditing heading editing feature}
+ * and {@link module:heading/headingui~HeadingUI heading UI feature}.
  *
  * @extends module:core/plugin~Plugin
  */
@@ -95,7 +96,7 @@ export default class Heading extends Plugin {
  * That's assumption is used by features like {@link module:autoformat/autoformat~Autoformat} to know which element
  * they should use when applying the first level heading.
  *
- * The defined headings are also available as values passed to `heading` command under their model names.
+ * The defined headings are also available as values passed to the `'heading'` command under their model names.
  * For example, the below code will apply `<heading1>` to the current selection:
  *
  *		editor.execute( 'heading', { value: 'heading1' } );

+ 8 - 6
packages/ckeditor5-heading/src/headingbuttonsui.js

@@ -22,9 +22,11 @@ const defaultIcons = {
 };
 
 /**
- * HeadingButtonsUI class creates a set of UI buttons that can be used instead of drop down component.
- * It is not enabled by default when using {@link module:heading/heading~Heading heading plugin}, and needs to be
- * added manually to the editor configuration.
+ * The `HeadingButtonsUI` plugin defines a set of UI buttons that can be used instead of the
+ * standard drop down component.
+ *
+ * This feature is not enabled by default by the {@link module:heading/heading~Heading} plugin and needs to be
+ * installed manually to the editor configuration.
  *
  * Plugin introduces button UI elements, which names are same as `model` property from {@link module:heading/heading~HeadingOption}.
  *
@@ -44,10 +46,10 @@ const defaultIcons = {
  *			.then( ... )
  *			.catch( ... );
  *
- * NOTE: Paragraph button is defined in {@link module:paragraph/paragraphbuttonui~ParagraphButtonUI} plugin that needs
- * to be loaded manually as well.
+ * NOTE: The `'paragraph'` button is defined in by the {@link module:paragraph/paragraphbuttonui~ParagraphButtonUI} plugin
+ * which needs to be loaded manually as well.
  *
- * It is possible to use custom icons by providing `icon` config option provided in {@link module:heading/heading~HeadingOption}.
+ * It is possible to use custom icons by providing `icon` config option in {@link module:heading/heading~HeadingOption}.
  * For the default configuration standard icons are used.
  *
  * @extends module:core/plugin~Plugin