Browse Source

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

Piotrek Koszuliński 7 years ago
parent
commit
6f08874ca4

+ 1 - 1
packages/ckeditor5-paragraph/docs/api/paragraph.md

@@ -10,7 +10,7 @@ This package implements paragraph support for CKEditor 5.
 
 ## Documentation
 
-See the {@link module:paragraph/paragraph~Paragraph} plugin documentation.
+See the {@link module:paragraph/paragraph~Paragraph} and {@link module:paragraph/paragraphbuttonui~ParagraphButtonUI} plugins documentation.
 
 ## Installation
 

+ 1 - 0
packages/ckeditor5-paragraph/src/paragraph.js

@@ -16,6 +16,7 @@ import Range from '@ckeditor/ckeditor5-engine/src/model/range';
 
 /**
  * The paragraph feature for the editor.
+ *
  * It introduces the `<paragraph>` element in the model which renders as a `<p>` element in the DOM and data.
  *
  * @extends module:core/plugin~Plugin

+ 6 - 5
packages/ckeditor5-paragraph/src/paragraphbuttonui.js

@@ -12,20 +12,21 @@ import ButtonView from '@ckeditor/ckeditor5-ui/src/button/buttonview';
 import icon from '../theme/icons/paragraph.svg';
 
 /**
- * Class creates UI component representing paragraph button. It can be used together with
- * {@link module:heading/headingbuttonsui~HeadingButtonsUI} to replace heading dropdown used in toolbars.
+ * This plugin defines the `'paragraphs'` button. It can be used together with
+ * {@link module:heading/headingbuttonsui~HeadingButtonsUI} to replace the standard heading dropdown.
  *
- * This plugin is not loaded automatically with {@link module:paragraph/paragraph~Paragraph paragraph plugin}. It must
- * be added manually in order to use `paragraph` component.
+ * This plugin is not loaded automatically by the {@link module:paragraph/paragraph~Paragraph} plugin. It must
+ * be added manually.
  *
  *		ClassicEditor
  *			.create( {
  *				plugins: [ ..., Heading, Paragraph, HeadingButtonsUI, ParagraphButtonUI ]
- * 				toolbar: [ 'paragraph', 'heading1', 'heading2', 'heading3' ]
+ *				toolbar: [ 'paragraph', 'heading1', 'heading2', 'heading3' ]
  *			} )
  *			.then( ... )
  *			.catch( ... );
  *
+ * @extends module:core/plugin~Plugin
  */
 export default class ParagraphButtonUI extends Plugin {
 	init() {