Browse Source

API docs fixes.

Piotrek Koszuliński 9 years ago
parent
commit
33fb840048

+ 6 - 6
packages/ckeditor5-engine/src/conversion/viewconversiondispatcher.js

@@ -210,14 +210,14 @@ export default class ViewConversionDispatcher {
 	 * Fired when {@link module:engine/view/text~Text} is converted.
 	 *
 	 * @event text
-	 * @see #element
+	 * @see #event:element
 	 */
 
 	/**
 	 * Fired when {@link module:engine/view/documentfragment~DocumentFragment} is converted.
 	 *
 	 * @event documentFragment
-	 * @see #element
+	 * @see #event:element
 	 */
 }
 
@@ -240,7 +240,7 @@ mix( ViewConversionDispatcher, EmitterMixin );
  * Every fired event is passed (as first parameter) an object with `output` property. Every event may set and/or
  * modify that property. When all callbacks are done, the final value of `output` property is returned by this method.
  *
- * @function convertItem
+ * @method #convertItem
  * @fires module:engine/conversion/viewconversiondispatcher~ViewConversionDispatcher#event:element
  * @fires module:engine/conversion/viewconversiondispatcher~ViewConversionDispatcher#event:text
  * @fires module:engine/conversion/viewconversiondispatcher~ViewConversionDispatcher#event:documentFragment
@@ -248,14 +248,14 @@ mix( ViewConversionDispatcher, EmitterMixin );
  * input Item to convert.
  * @param {module:engine/conversion/viewconsumable~ViewConsumable} consumable Values to consume.
  * @param {Object} [additionalData] Additional data to be passed in `data` argument when firing `ViewConversionDispatcher`
- * events. See also {@link ~ViewConversionDispatcher#event:element element event}.
+ * events. See also {@link module:engine/conversion/viewconversiondispatcher~ViewConversionDispatcher#event:element element event}.
  * @returns {*} The result of item conversion, created and modified by callbacks attached to fired event.
  */
 
 /**
  * Starts conversion of all children of given item by firing appropriate events for all those children.
  *
- * @function convertChildren
+ * @method #convertChildren
  * @fires module:engine/conversion/viewconversiondispatcher~ViewConversionDispatcher#event:element
  * @fires module:engine/conversion/viewconversiondispatcher~ViewConversionDispatcher#event:text
  * @fires module:engine/conversion/viewconversiondispatcher~ViewConversionDispatcher#event:documentFragment
@@ -263,6 +263,6 @@ mix( ViewConversionDispatcher, EmitterMixin );
  * input Item which children will be converted.
  * @param {module:engine/conversion/viewconsumable~ViewConsumable} consumable Values to consume.
  * @param {Object} [additionalData] Additional data to be passed in `data` argument when firing `ViewConversionDispatcher`
- * events. See also {@link ~ViewConversionDispatcher#event:element element event}.
+ * events. See also {@link module:engine/conversion/viewconversiondispatcher~ViewConversionDispatcher#event:element element event}.
  * @returns {Array.<*>} Array containing results of conversion of all children of given item.
  */

+ 1 - 1
packages/ckeditor5-engine/src/model/document.js

@@ -37,7 +37,7 @@ const graveyardName = '$graveyard';
  *
  *		doc.batch().insert( position, nodes ).split( otherPosition );
  *
- * @see ~Document#batch
+ * @see module:engine/model/document~Document#batch
  * @mixes module:utils/emittermixin~EmitterMixin
  */
 export default class Document {

+ 1 - 1
packages/ckeditor5-engine/src/model/schema.js

@@ -314,7 +314,7 @@ export default class Schema {
 	/**
 	 * Disallows given query in the schema.
 	 *
-	 * @see {@link module:engine/model/schema~Schema#allow}
+	 * @see #allow
 	 * @param {module:engine/model/schema~SchemaQuery} query Disallowed query.
 	 */
 	disallow( query ) {

+ 1 - 1
packages/ckeditor5-engine/src/view/filler.js

@@ -39,7 +39,7 @@ import { keyCodes } from '../../utils/keyboard.js';
  * `<br> filler creator. This is a function which creates `<br data-cke-filler="true">` element.
  * It defines how the filler is created.
  *
- * @see module:engine/view/filler~NBSP_FILLER_FILLER
+ * @see module:engine/view/filler~NBSP_FILLER
  * @function
  */
 export const BR_FILLER = ( domDocument ) => {

+ 2 - 1
packages/ckeditor5-engine/src/view/observer/mutationobserver.js

@@ -26,7 +26,8 @@ import { startsWithFiller, getDataWithoutFiller } from '../filler.js';
  * {@link module:engine/view/observer/mutationobserver~MutatedText text mutation} is fired only if parent element do not change child list.
  *
  * Note that this observer is attached by the {@link module:engine/view/document~Document} and is available by default.
- * @extends module:engine/view/observer/observer~Observer.Observer
+ *
+ * @extends module:engine/view/observer/observer~Observer
  */
 export default class MutationObserver extends Observer {
 	constructor( document ) {

+ 2 - 2
packages/ckeditor5-engine/src/view/observer/selectionobserver.js

@@ -22,8 +22,8 @@ import log from '../../../utils/log.js';
  *
  * Note that this observer is attached by the {@link module:engine/view/document~Document} and is available by default.
  *
- * @see module:engine/view/mutationobserver~MutationObserver
- * @extends module:engine/view/observer/observer~Observer.Observer
+ * @see module:engine/view/observer/mutationobserver~MutationObserver
+ * @extends module:engine/view/observer/observer~Observer
  */
 export default class SelectionObserver extends Observer {
 	constructor( document ) {

+ 2 - 2
packages/ckeditor5-engine/src/view/selection.js

@@ -91,7 +91,7 @@ export default class Selection {
 	/**
 	 * Returns true if selection instance is marked as `fake`.
 	 *
-	 * @see {@link #setFake}
+	 * @see #setFake
 	 * @returns {Boolean}
 	 */
 	get isFake() {
@@ -101,7 +101,7 @@ export default class Selection {
 	/**
 	 * Returns fake selection label.
 	 *
-	 * @see {@link #setFake}
+	 * @see #setFake
 	 * @returns {String}
 	 */
 	get fakeSelectionLabel() {