Skip to content

Commit

Permalink
web: Fixed some broken links in docs
Browse files Browse the repository at this point in the history
  • Loading branch information
Dinnerbone committed Oct 6, 2024
1 parent 2675084 commit 79f43fd
Show file tree
Hide file tree
Showing 8 changed files with 18 additions and 18 deletions.
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ import { isSwf } from "../../swf-utils";
* A polyfill html element.
*
* This specific class tries to polyfill existing `<embed>` tags,
* and should not be used. Prefer [[RufflePlayer]] instead.
* and should not be used. Prefer {@link RufflePlayer} instead.
*
* @internal
*/
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@ import { isSwf } from "../../swf-utils";
* @param obj Object to check
* @param key Key to find
* @param defaultValue Value if not found
* @returns Value if found, else [[defaultValue]]
* @returns Value if found, else {@link defaultValue}
*/
function findCaseInsensitive(
obj: Record<string, string>,
Expand All @@ -34,7 +34,7 @@ function findCaseInsensitive(
}

/**
* Returns all flash params ([[HTMLParamElement]]) that are for the given object.
* Returns all flash params ({@link HTMLParamElement}) that are for the given object.
*
* @param elem Element to check.
* @returns A record of every parameter.
Expand All @@ -59,7 +59,7 @@ function paramsOf(elem: Element): Record<string, string> {
* A polyfill html element.
*
* This specific class tries to polyfill existing `<object>` tags,
* and should not be used. Prefer [[RufflePlayer]] instead.
* and should not be used. Prefer {@link RufflePlayer} instead.
*
* @internal
*/
Expand Down
2 changes: 1 addition & 1 deletion web/packages/core/src/load-options.ts
Original file line number Diff line number Diff line change
Expand Up @@ -676,7 +676,7 @@ export interface URLLoadOptions extends BaseLoadOptions {
/**
* The URL to load a movie from.
*
* If there is a query portion of this URL, then default [[parameters]]
* If there is a query portion of this URL, then default {@link parameters}
* will be extracted from that.
*/
url: string;
Expand Down
8 changes: 4 additions & 4 deletions web/packages/core/src/public-api.ts
Original file line number Diff line number Diff line change
Expand Up @@ -8,8 +8,8 @@ declare global {
/**
* The public API for generating a ruffle player.
* This may be a config holder, which will be converted to a
* [[PublicAPI]] via [[installRuffle]], or an actual
* [[PublicAPI]] instance itself.
* {@link PublicAPI} via {@link installRuffle}, or an actual
* {@link PublicAPI} instance itself.
*/
RufflePlayer?: PublicAPILike | PublicAPI;
}
Expand All @@ -18,8 +18,8 @@ declare global {
/**
* Represents a potential installation of a Ruffle public API.
*
* Unlike [[PublicAPI]], this may come from any source, past or future.
* It needs to be forwards compatible and convertible into a modern day [[PublicAPI]].
* Unlike {@link PublicAPI}, this may come from any source, past or future.
* It needs to be forwards compatible and convertible into a modern day {@link PublicAPI}.
*/
export interface PublicAPILike {
config?: DataLoadOptions | URLLoadOptions | object;
Expand Down
12 changes: 6 additions & 6 deletions web/packages/core/src/public/legacy.ts
Original file line number Diff line number Diff line change
Expand Up @@ -48,7 +48,7 @@ export interface LegacyRuffleAPI {
get metadata(): MovieMetadata | null;

/**
* Reloads the player, as if you called {@link RufflePlayer.load} with the same config as the last time it was called.
* Reloads the player, as if you called {@link load} with the same config as the last time it was called.
*
* If this player has never been loaded, this method will return an error.
*/
Expand All @@ -61,13 +61,13 @@ export interface LegacyRuffleAPI {
*
* @param options One of the following:
* - A URL, passed as a string, which will load a URL with default options.
* - A [[URLLoadOptions]] object, to load a URL with options.
* - A [[DataLoadOptions]] object, to load data with options.
* - A {@link URLLoadOptions} object, to load a URL with options.
* - A {@link DataLoadOptions} object, to load data with options.
* The options, if provided, must only contain values provided for this specific movie.
* They must not contain any default values, since those would overwrite other configuration
* settings with a lower priority (e.g. the general RufflePlayer config).
*
* The options will be defaulted by the [[config]] field, which itself
* The options will be defaulted by the {@link config} field, which itself
* is defaulted by a global `window.RufflePlayer.config`.
*/
load(options: string | URLLoadOptions | DataLoadOptions): Promise<void>;
Expand Down Expand Up @@ -105,7 +105,7 @@ export interface LegacyRuffleAPI {
/**
* Checks if this player is allowed to be fullscreen by the browser.
*
* @returns True if you may call [[enterFullscreen]].
* @returns True if you may call {@link enterFullscreen}.
*/
get fullscreenEnabled(): boolean;

Expand All @@ -127,7 +127,7 @@ export interface LegacyRuffleAPI {
/**
* Requests the browser to make this player fullscreen.
*
* This is not guaranteed to succeed, please check [[fullscreenEnabled]] first.
* This is not guaranteed to succeed, please check {@link fullscreenEnabled} first.
*/
enterFullscreen(): void;

Expand Down
2 changes: 1 addition & 1 deletion web/packages/core/src/source-api.ts
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ import { Player } from "./public/player";
*
* Multiple APIs can be instantiated from different sources; e.g. an "extension"
* version, versus a "local" version. This expresses to the Public API
* negotiator (see [[PublicAPI]]) what this particular version of Ruffle is and
* negotiator (see {@link PublicAPI}) what this particular version of Ruffle is and
* how to control it.
*/
export interface SourceAPI {
Expand Down
2 changes: 1 addition & 1 deletion web/packages/core/src/version-range.ts
Original file line number Diff line number Diff line change
Expand Up @@ -43,7 +43,7 @@ export class VersionRange {
* Constructs a range of versions as specified by the given requirements.
*
* If you wish to construct this object from a string representation,
* then use [[fromRequirementString]].
* then use {@link fromRequirementString}.
*
* @param requirements Requirements to set this range by
*/
Expand Down
2 changes: 1 addition & 1 deletion web/packages/core/src/version.ts
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ export class Version {
/**
* Construct a Version from specific components.
*
* If you wish to parse a string into a Version then please use [[fromSemver]].
* If you wish to parse a string into a Version then please use {@link fromSemver}.
*
* @param major The major version component.
* @param minor The minor version component.
Expand Down

0 comments on commit 79f43fd

Please sign in to comment.