Skip to content
This repository has been archived by the owner on Jun 26, 2020. It is now read-only.

Commit

Permalink
Docs: Fixed broken links.
Browse files Browse the repository at this point in the history
  • Loading branch information
oleq committed Mar 7, 2017
1 parent d40c01b commit f3d5395
Show file tree
Hide file tree
Showing 8 changed files with 37 additions and 31 deletions.
4 changes: 2 additions & 2 deletions src/dropdown/dropdownview.js
Original file line number Diff line number Diff line change
Expand Up @@ -69,10 +69,10 @@ export default class DropdownView extends View {
this.focusTracker = new FocusTracker();

/**
* Instance of the {@link module:core/keystrokehandler~KeystrokeHandler}.
* Instance of the {@link module:utils/keystrokehandler~KeystrokeHandler}.
*
* @readonly
* @member {module:core/keystrokehandler~KeystrokeHandler}
* @member {module:utils/keystrokehandler~KeystrokeHandler}
*/
this.keystrokes = new KeystrokeHandler();

Expand Down
22 changes: 11 additions & 11 deletions src/focuscycler.js
Original file line number Diff line number Diff line change
Expand Up @@ -52,7 +52,7 @@ export default class FocusCycler {
* @param {Object} options Configuration options.
* @param {module:utils/collection~Collection|Object} options.focusables
* @param {module:utils/focustracker~FocusTracker} options.focusTracker
* @param {module:core/keystrokehandler~KeystrokeHandler} [options.keystrokeHandler]
* @param {module:utils/keystrokehandler~KeystrokeHandler} [options.keystrokeHandler]
* @param {Object} [options.actions]
*/
constructor( options ) {
Expand All @@ -67,17 +67,17 @@ export default class FocusCycler {

/**
* A focus tracker instance that cycler uses to determine focus
* state in {@link #viewCollection}.
* state in {@link #focusables}.
*
* @readonly
* @member {module:utils/focustracker~FocusTracker} #focusTracker
*/

/**
* Instance of the {@link module:core/keystrokehandler~KeystrokeHandler}.
* Instance of the {@link module:utils/keystrokehandler~KeystrokeHandler}.
*
* @readonly
* @member {module:core/keystrokehandler~KeystrokeHandler} #keystrokeHandler
* @member {module:utils/keystrokehandler~KeystrokeHandler} #keystrokeHandler
*/

/**
Expand Down Expand Up @@ -117,7 +117,7 @@ export default class FocusCycler {
}

/**
* Returns the first focusable view in {@link #viewCollection}.
* Returns the first focusable view in {@link #focusables}.
* `null` if there's none.
*
* @readonly
Expand All @@ -128,7 +128,7 @@ export default class FocusCycler {
}

/**
* Returns the last focusable view in {@link #viewCollection}.
* Returns the last focusable view in {@link #focusables}.
* `null` if there's none.
*
* @readonly
Expand All @@ -139,7 +139,7 @@ export default class FocusCycler {
}

/**
* Returns the next focusable view in {@link #viewCollection} based on {@link #current}.
* Returns the next focusable view in {@link #focusables} based on {@link #current}.
* `null` if there's none.
*
* @readonly
Expand All @@ -150,7 +150,7 @@ export default class FocusCycler {
}

/**
* Returns the previous focusable view in {@link #viewCollection} based on {@link #current}.
* Returns the previous focusable view in {@link #focusables} based on {@link #current}.
* `null` if there's none.
*
* @readonly
Expand All @@ -161,7 +161,7 @@ export default class FocusCycler {
}

/**
* An index of the view in the {@link #viewCollection} which is focused according
* An index of the view in the {@link #focusables} which is focused according
* to {@link #focusTracker}. `null` when there's no such view.
*
* @readonly
Expand All @@ -170,7 +170,7 @@ export default class FocusCycler {
get current() {
let index = null;

// There's no focused view in the viewCollection.
// There's no focused view in the focusables.
if ( this.focusTracker.focusedElement === null ) {
return null;
}
Expand Down Expand Up @@ -229,7 +229,7 @@ export default class FocusCycler {
}

/**
* Returns the next/previous focusable view in {@link #viewCollection} with respect
* Returns the next/previous focusable view in {@link #focusables} with respect
* to {@link #current}.
*
* @protected
Expand Down
4 changes: 2 additions & 2 deletions src/list/listview.js
Original file line number Diff line number Diff line change
Expand Up @@ -42,10 +42,10 @@ export default class ListView extends View {
this.focusTracker = new FocusTracker();

/**
* Instance of the {@link module:core/keystrokehandler~KeystrokeHandler}.
* Instance of the {@link module:utils/keystrokehandler~KeystrokeHandler}.
*
* @readonly
* @member {module:core/keystrokehandler~KeystrokeHandler}
* @member {module:utils/keystrokehandler~KeystrokeHandler}
*/
this.keystrokes = new KeystrokeHandler();

Expand Down
15 changes: 8 additions & 7 deletions src/panel/balloon/balloonpanelview.js
Original file line number Diff line number Diff line change
Expand Up @@ -54,7 +54,8 @@ export default class BalloonPanelView extends View {
* controls the minor aspects of the balloon's visual appearance like placement
* of the "arrow". To support a new position, an additional CSS must be created.
*
* Default position names correspond with {@link #defaultPositions}.
* Default position names correspond with
* {@link module:ui/panel/balloon/balloonpanelview~BalloonPanelView.defaultPositions}.
*
* @observable
* @default 'se'
Expand Down Expand Up @@ -136,7 +137,7 @@ export default class BalloonPanelView extends View {
*
* @param {module:utils/dom/position~Options} options Positioning options compatible with
* {@link module:utils/dom/position~getOptimalPosition}. Default `positions` array is
* {@link module:ui/balloonpanel/balloonpanelview~BalloonPanelView.defaultPositions}.
* {@link module:ui/panel/balloon/balloonpanelview~BalloonPanelView.defaultPositions}.
*/
attachTo( options ) {
this.show();
Expand Down Expand Up @@ -174,7 +175,7 @@ export default class BalloonPanelView extends View {
* >|-----|<---------------- horizontal offset
*
* @default 30
* @member {Number} module:ui/balloonpanel/balloonpanelview~BalloonPanelView.arrowHorizontalOffset
* @member {Number} module:ui/panel/balloon/balloonpanelview~BalloonPanelView.arrowHorizontalOffset
*/
BalloonPanelView.arrowHorizontalOffset = 30;

Expand All @@ -193,13 +194,13 @@ BalloonPanelView.arrowHorizontalOffset = 30;
* ^
*
* @default 15
* @member {Number} module:ui/balloonpanel/balloonpanelview~BalloonPanelView.arrowVerticalOffset
* @member {Number} module:ui/panel/balloon/balloonpanelview~BalloonPanelView.arrowVerticalOffset
*/
BalloonPanelView.arrowVerticalOffset = 15;

/**
* A default set of positioning functions used by the balloon panel view
* when attaching using {@link #attachTo} method.
* when attaching using {@link module:ui/panel/balloon/balloonpanelview~BalloonPanelView#attachTo} method.
*
* The available positioning functions are as follows:
*
Expand Down Expand Up @@ -238,14 +239,14 @@ BalloonPanelView.arrowVerticalOffset = 15;
* V
* [ Target ]
*
* See {@link #attachTo}.
* See {@link module:ui/panel/balloon/balloonpanelview~BalloonPanelView#attachTo}.
*
* Positioning functions must be compatible with {@link module:utils/dom/position~Position}.
*
* The name that position function returns will be reflected in balloon panel's class that
* controls the placement of the "arrow". See {@link #position} to learn more.
*
* @member {Object} module:ui/balloonpanel/balloonpanelview~BalloonPanelView.defaultPositions
* @member {Object} module:ui/panel/balloon/balloonpanelview~BalloonPanelView.defaultPositions
*/
BalloonPanelView.defaultPositions = {
se: ( targetRect ) => ( {
Expand Down
12 changes: 8 additions & 4 deletions src/panel/floating/floatingpanelview.js
Original file line number Diff line number Diff line change
Expand Up @@ -16,9 +16,13 @@ import { getOptimalPosition } from '@ckeditor/ckeditor5-utils/src/dom/position';
const toPx = toUnit( 'px' );

/**
* The floating panel view class. It floats around the {@link #targetElement}
* The floating panel view class. It floats around the
* {@link module:ui/panel/floating/floatingpanelview~FloatingPanelView#targetElement} in DOM
* to remain visible in the browser viewport.
*
* See {@link module:ui/panel/floating/floatingpanelview~FloatingPanelView.defaultPositions}
* to learn about the positioning.
*
* @extends module:ui/view~View
*/
export default class FloatingPanelView extends View {
Expand Down Expand Up @@ -128,7 +132,7 @@ export default class FloatingPanelView extends View {

/**
* A default set of positioning functions used by the panel view to float
* around {@link targetElement}.
* around {@link module:ui/panel/floating/floatingpanelview~FloatingPanelView#targetElement}.
*
* The available positioning functions are as follows:
*
Expand Down Expand Up @@ -161,11 +165,11 @@ export default class FloatingPanelView extends View {
* | #targetElement |
* +----------------+
*
* See {@link #_updatePosition}.
* See {@link module:ui/panel/floating/floatingpanelview~FloatingPanelView#_updatePosition}.
*
* Positioning functions must be compatible with {@link module:utils/dom/position~Position}.
*
* @member {Object} module:ui/floatingpanel/floatingpanelview~FloatingPanelView#defaultPositions
* @member {Object} module:ui/panel/floating/floatingpanelview~FloatingPanelView.defaultPositions
*/
FloatingPanelView.defaultPositions = {
nw: ( targetRect, panelRect ) => ( {
Expand Down
5 changes: 3 additions & 2 deletions src/template.js
Original file line number Diff line number Diff line change
Expand Up @@ -572,7 +572,7 @@ export default class Template {
* needed.
*
* @private
* @param {Object} styles module:ui/template~TemplateDefinition.attributes.styles Styles definition.
* @param {Object} styles Styles located in `attributes.style` of {@link module:ui/template~TemplateDefinition}.
* @param {module:ui/template~RenderConfig} config Rendering config.
*/
_renderStyleAttribute( styles, config ) {
Expand Down Expand Up @@ -656,7 +656,8 @@ export default class Template {
}

/**
* Activates {@link module:ui/template~Template#on} listeners on a passed `HTMLElement`.
* Activates `on` listeners in the {@link module:ui/template~TemplateDefinition}
* on a passed `HTMLElement`.
*
* @protected
* @param {module:ui/template~RenderConfig} config Rendering config.
Expand Down
2 changes: 1 addition & 1 deletion src/toolbar/enabletoolbarkeyboardfocus.js
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@
* @param {Object} options Options of the utility.
* @param {*} options.origin A view to which the focus will return when `Esc` is pressed and
* `options.toolbar` is focused.
* @param {module:core/keystrokehandler~KeystrokeHandler} options.originKeystrokeHandler A keystroke
* @param {module:utils/keystrokehandler~KeystrokeHandler} options.originKeystrokeHandler A keystroke
* handler to register `Alt+F10` keystroke.
* @param {module:utils/focustracker~FocusTracker} options.originFocusTracker A focus tracker
* for `options.origin`.
Expand Down
4 changes: 2 additions & 2 deletions src/toolbar/toolbarview.js
Original file line number Diff line number Diff line change
Expand Up @@ -43,10 +43,10 @@ export default class ToolbarView extends View {
this.focusTracker = new FocusTracker();

/**
* Instance of the {@link module:core/keystrokehandler~KeystrokeHandler}.
* Instance of the {@link module:utils/keystrokehandler~KeystrokeHandler}.
*
* @readonly
* @member {module:core/keystrokehandler~KeystrokeHandler}
* @member {module:utils/keystrokehandler~KeystrokeHandler}
*/
this.keystrokes = new KeystrokeHandler();

Expand Down

0 comments on commit f3d5395

Please sign in to comment.