Skip to content

Commit

Permalink
web: Resolve a TypeDoc warning in the comment for Setup
Browse files Browse the repository at this point in the history
ruffle/web $ npm run docs
> [warning] Failed to resolve link to "PlayerElement" in comment for Setup
  • Loading branch information
torokati44 committed Nov 29, 2024
1 parent 3838dc2 commit 0c1806b
Showing 1 changed file with 2 additions and 2 deletions.
4 changes: 2 additions & 2 deletions web/packages/core/src/public/setup/index.ts
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
/**
* The Setup module contains the interfaces and methods needed to install Ruffle onto a page,
* and create a {@link PlayerElement} with the latest version of Ruffle available.
* and create a {@link Player.PlayerElement} with the latest version of Ruffle available.
*
* This is primarily relevant to users of `ruffle-core` as a npm module, as the "selfhosted" version of Ruffle preinstalls itself,
* and without type checking the interfaces here are of limited use.
Expand All @@ -10,7 +10,7 @@
*
* Multiple sources of Ruffle may exist - for example, the Ruffle browser extension also installs itself on page load.
* For this reason, you are required to call `window.RufflePlayer.newest()` (for example) to grab the latest {@link SourceAPI},
* from which you can create a {@link PlayerElement} via {@link SourceAPI.createPlayer}.
* from which you can create a {@link Player.PlayerElement} via {@link SourceAPI.createPlayer}.
*
* @module
*/
Expand Down

0 comments on commit 0c1806b

Please sign in to comment.