Explorar o código

Enhance docs of the features.

Maciej Gołaszewski %!s(int64=6) %!d(string=hai) anos
pai
achega
3eeb2c8786

+ 6 - 3
packages/ckeditor5-restricted-editing/src/restrictededitingmode.js

@@ -14,12 +14,12 @@ import RestrictedEditingModeUI from './restrictededitingmodeui';
 import '../theme/restrictedediting.css';
 
 /**
- * The restricted mode plugin.
+ * The Restricted Editing Mode plugin.
  *
  * This is a "glue" plugin which loads the following plugins:
  *
- * * The restricted mode editing feature and
- * * The restricted mode ui feature.
+ * * The {@link module:restricted-editing/restrictededitingmodeediting~RestrictedEditingModeEditing restricted mode editing feature} and
+ * * The {@link module:restricted-editing/restrictededitingmodeui~RestrictedEditingModeUI restricted mode ui feature}.
  *
  * @extends module:core/plugin~Plugin
  */
@@ -31,6 +31,9 @@ export default class RestrictedEditingMode extends Plugin {
 		return 'RestrictedEditingMode';
 	}
 
+	/**
+	 * @inheritDoc
+	 */
 	static get requires() {
 		return [ RestrictedEditingModeEditing, RestrictedEditingModeUI ];
 	}

+ 1 - 1
packages/ckeditor5-restricted-editing/src/restrictededitingmodeediting.js

@@ -14,7 +14,7 @@ import RestrictedEditingNavigationCommand from './restrictededitingmodenavigatio
 const HIGHLIGHT_CLASS = 'ck-restricted-editing-exception_selected';
 
 /**
- * The Restricted Editing editing feature.
+ * The Restricted Editing Mode editing feature.
  *
  * * It introduces the exception marker group that renders to `<spans>` with the `ck-restricted-editing-exception` CSS class.
  * * It registers the `'goToPreviousRestrictedEditingRegion'` and `'goToNextRestrictedEditingRegion'` commands.

+ 1 - 1
packages/ckeditor5-restricted-editing/src/restrictededitingmodeui.js

@@ -14,7 +14,7 @@ import lockIcon from '../theme/icons/contentlock.svg';
 import Collection from '@ckeditor/ckeditor5-utils/src/collection';
 
 /**
- * The Restricted Editing UI feature.
+ * The Restricted Editing Mode UI feature.
  *
  * It introduces the `'restrictedEditing'` dropdown that offers tools to navigate exceptions across
  * the document.

+ 7 - 0
packages/ckeditor5-restricted-editing/src/standardeditingmode.js

@@ -15,6 +15,13 @@ import StandardEditingModeUI from './standardeditingmodeui';
 import '../theme/restrictedediting.css';
 
 /**
+ * The Standard Editing Mode plugin.
+ *
+ * This is a "glue" plugin which loads the following plugins:
+ *
+ * * The {@link module:restricted-editing/standardeditingmodeediting~StandardEditingModeEditing standard mode editing feature} and
+ * * The {@link module:restricted-editing/standardeditingmodeui~StandardEditingModeUI standard mode ui feature}.
+ *
  * @extends module:core/plugin~Plugin
  */
 export default class StandardEditingMode extends Plugin {

+ 6 - 0
packages/ckeditor5-restricted-editing/src/standardeditingmodeediting.js

@@ -11,6 +11,12 @@ import Plugin from '@ckeditor/ckeditor5-core/src/plugin';
 import RestrictedEditingExceptionCommand from './restrictededitingexceptioncommand';
 
 /**
+ * The Standard Editing Mode editing feature.
+ *
+ * * It introduces the `restrictedEditingException` text attributes that is rendered as
+ * `<spans>` with the `ck-restricted-editing-exception` CSS class.
+ * * It registers the `'restrictedEditingException'` command.
+ *
  * @extends module:core/plugin~Plugin
  */
 export default class StandardEditingModeEditing extends Plugin {

+ 4 - 0
packages/ckeditor5-restricted-editing/src/standardeditingmodeui.js

@@ -13,6 +13,10 @@ import ButtonView from '@ckeditor/ckeditor5-ui/src/button/buttonview';
 import unlockIcon from '../theme/icons/contentunlock.svg';
 
 /**
+ * The Standard Editing Mode UI feature.
+ *
+ * It introduces the `'restrictedEditingException'` button that marks text as unrestricted for editing.
+ *
  * @extends module:core/plugin~Plugin
  */
 export default class StandardEditingModeUI extends Plugin {