Skip to content

Commit 994a86f

Browse files
Updated JSDocs
1 parent 2844d82 commit 994a86f

File tree

2 files changed

+22
-9
lines changed

2 files changed

+22
-9
lines changed

source/interfaces/unity-instance-parameters.ts

Lines changed: 16 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -5,62 +5,69 @@ export interface IUnityInstanceParameters {
55
* The url to the build data file generated by Unity. When using a relative url,
66
* keep in mind this is relative from the path where your html file is served.
77
* @public
8+
* @readonly
89
* @type {string}
910
*/
10-
dataUrl: string;
11+
readonly dataUrl: string;
1112

1213
/**
1314
* The url to the framework file generated by Unity. When using a relative url,
1415
* keep in mind this is relative from the path where your html file is served.
1516
* @public
17+
* @readonly
1618
* @type {string}
1719
*/
18-
frameworkUrl: string;
20+
readonly frameworkUrl: string;
1921

2022
/**
2123
* The url to the unity code file generated by Unity. When using a relative url,
2224
* keep in mind this is relative from the path where your html file is served.
2325
* @public
26+
* @readonly
2427
* @type {string}
2528
*/
26-
codeUrl: string;
29+
readonly codeUrl: string;
2730

2831
/**
2932
* The url where the streaming assets can be found. When using a relative url,
3033
* keep in mind this is relative from the path where your html file is served.
3134
* @public
35+
* @readonly
3236
* @type {string}
3337
*/
34-
streamingAssetsUrl?: string;
38+
readonly streamingAssetsUrl?: string;
3539

3640
/**
3741
* The applications company name.
3842
* @public
43+
* @readonly
3944
* @type {string}
4045
*/
41-
companyName?: string;
46+
readonly companyName?: string;
4247

4348
/**
4449
* The applications product name.
4550
* @public
51+
* @readonly
4652
* @type {string}
4753
*/
48-
productName?: string;
54+
readonly productName?: string;
4955

5056
/**
5157
* The applications product version.
5258
* @public
59+
* @readonly
5360
* @type {string}
5461
*/
55-
productVersion?: string;
62+
readonly productVersion?: string;
5663

5764
/**
5865
* The Canvas can appear too blurry on retina screens. The devicePixelRatio
5966
* determines how much extra pixel density should be added to allow for a
6067
* sharper image.
61-
* @see https://developer.mozilla.org/en-US/docs/Web/API/Window/devicePixelRatio
6268
* @public
6369
* @type {number}
70+
* @see https://developer.mozilla.org/en-US/docs/Web/API/Window/devicePixelRatio
6471
*/
6572
devicePixelRatio?: number;
6673

@@ -78,9 +85,9 @@ export interface IUnityInstanceParameters {
7885
/**
7986
* This object allow you to configure WebGLRenderingContext creation options
8087
* which will be pass additional context attributes to the Unity canvas.
81-
* @see https://developer.mozilla.org/en-US/docs/Web/API/WebGLRenderingContext
8288
* @public
8389
* @type {IWebGLContextAttributes}
90+
* @see https://developer.mozilla.org/en-US/docs/Web/API/WebGLRenderingContext
8491
*/
8592
webglContextAttributes?: IWebGLContextAttributes;
8693

source/library/event-system.ts

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -29,6 +29,12 @@ const dispatchReactUnityEvent = function (
2929
* An event system.
3030
*/
3131
export class EventSystem {
32+
/**
33+
* The event map contains all the events that have been registered to the
34+
* event system as a key-value pair of event name and event listener.
35+
* @private
36+
* @readonly
37+
*/
3238
private readonly eventMap = new Map<string, Function>();
3339

3440
constructor() {

0 commit comments

Comments
 (0)