8
0
Просмотр исходного кода

Docs: fixed few links and types.

Maciek 9 лет назад
Родитель
Сommit
894ffa7f08

+ 4 - 3
packages/ckeditor5-utils/src/ckeditorerror.js

@@ -14,6 +14,7 @@
  * Therefore, all error messages should be documented in the same way as those in {@link module:utils/log}.
  *
  * Read more in the {@link module:utils/log} module.
+ *
  * @extends Error
  */
 export default class CKEditorError extends Error {
@@ -26,7 +27,7 @@ export default class CKEditorError extends Error {
 	 * During the minification process the "Error message" part will be removed to limit the code size
 	 * and a link to this error documentation will be added to the `message`.
 	 * @param {Object} [data] Additional data describing the error. A stringified version of this object
-	 * will be appended to the error {@link #message}, so the data are quickly visible in the console. The original
+	 * will be appended to the error message, so the data are quickly visible in the console. The original
 	 * data object will also be later available under the {@link #data} property.
 	 */
 	constructor( message, data ) {
@@ -37,14 +38,14 @@ export default class CKEditorError extends Error {
 		super( message );
 
 		/**
-		 * @member {String} name
+		 * @member {String}
 		 */
 		this.name = 'CKEditorError';
 
 		/**
 		 * The additional error data passed to the constructor.
 		 *
-		 * @member {Object} data
+		 * @member {Object}
 		 */
 		this.data = data;
 	}

+ 1 - 1
packages/ckeditor5-utils/src/collection.js

@@ -76,7 +76,7 @@ export default class Collection {
 	 * @param {Object} item
 	 * @param {Number} [index] The position of the item in the collection. The item
 	 * is pushed to the collection when `index` not specified.
-	 * @fires add
+	 * @fires #add
 	 */
 	add( item, index ) {
 		let itemId;

+ 1 - 1
packages/ckeditor5-utils/src/focustracker.js

@@ -111,7 +111,7 @@ export default class FocusTracker {
 	 * This method uses `setTimeout` to change order of fires `blur` and `focus` events.
 	 *
 	 * @private
-	 * @fires blur
+	 * @fires #_blur
 	 */
 	_blur() {
 		this._nextEventLoopTimeout = setTimeout( () => {

+ 1 - 1
packages/ckeditor5-utils/src/keyboard.js

@@ -23,7 +23,7 @@ import env from './env.js';
  * * `backspace`, `delete`, `enter`, `esc`, `tab`,
  * * `ctrl`, `cmd`, `shift`, `alt`.
  *
- * @member {Object} module:utils/keyboard~keyCodes
+ * @constant {Object} module:utils/keyboard~keyCodes
  */
 export const keyCodes = generateKnownKeyCodes();
 

+ 16 - 2
packages/ckeditor5-utils/src/observablemixin.js

@@ -18,7 +18,7 @@ const boundAttributesSymbol = Symbol( 'boundAttributes' );
 
 /**
  * Mixin that injects the "observable attributes" and data binding functionality.
- * Used mainly in the {@link ui.Model} class.
+ * Used mainly in the {@link module:ui/model~Model} class.
  *
  * @mixin ObservableMixin
  * @mixes module:utils/emittermixin~EmitterMixin
@@ -97,7 +97,7 @@ const ObservableMixin = {
 
 	/**
 	 * Binds observable attributes to another objects implementing {@link ~ObservableMixin}
-	 * interface (like {@link ui.Model}).
+	 * interface (like {@link module:ui/model~Model}).
 	 *
 	 * Once bound, the observable will immediately share the current state of attributes
 	 * of the observable it is bound to and react to the changes to these attributes
@@ -248,6 +248,20 @@ const ObservableMixin = {
 			boundAttributes.clear();
 		}
 	}
+	/**
+	 * @private
+	 * @method ~ObservableMixin#_boundAttributes
+	 */
+
+	/**
+	 * @private
+	 * @method ~ObservableMixin#_boundObservables
+	 */
+
+	/**
+	 * @private
+	 * @method ~ObservableMixin#_bindTo
+	 */
 };
 
 export default ObservableMixin;