Skip to content

Commit 0c1806b

Browse files
committed
web: Resolve a TypeDoc warning in the comment for Setup
ruffle/web $ npm run docs > [warning] Failed to resolve link to "PlayerElement" in comment for Setup
1 parent 3838dc2 commit 0c1806b

File tree

1 file changed

+2
-2
lines changed
  • web/packages/core/src/public/setup

1 file changed

+2
-2
lines changed

web/packages/core/src/public/setup/index.ts

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
/**
22
* The Setup module contains the interfaces and methods needed to install Ruffle onto a page,
3-
* and create a {@link PlayerElement} with the latest version of Ruffle available.
3+
* and create a {@link Player.PlayerElement} with the latest version of Ruffle available.
44
*
55
* This is primarily relevant to users of `ruffle-core` as a npm module, as the "selfhosted" version of Ruffle preinstalls itself,
66
* and without type checking the interfaces here are of limited use.
@@ -10,7 +10,7 @@
1010
*
1111
* Multiple sources of Ruffle may exist - for example, the Ruffle browser extension also installs itself on page load.
1212
* For this reason, you are required to call `window.RufflePlayer.newest()` (for example) to grab the latest {@link SourceAPI},
13-
* from which you can create a {@link PlayerElement} via {@link SourceAPI.createPlayer}.
13+
* from which you can create a {@link Player.PlayerElement} via {@link SourceAPI.createPlayer}.
1414
*
1515
* @module
1616
*/

0 commit comments

Comments
 (0)