Skip to content

Commit 2844d82

Browse files
Updated JSDocs
1 parent 9f1f296 commit 2844d82

File tree

1 file changed

+10
-1
lines changed

1 file changed

+10
-1
lines changed

source/interfaces/unity-config.ts

Lines changed: 10 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -5,6 +5,7 @@ export interface IUnityConfig {
55
* The url to the build json 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
*/
1011
readonly loaderUrl: string;
@@ -13,6 +14,7 @@ export interface IUnityConfig {
1314
* The url to the build data 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
*/
1820
readonly dataUrl: string;
@@ -21,6 +23,7 @@ export interface IUnityConfig {
2123
* The url to the framework 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
*/
2629
readonly frameworkUrl: string;
@@ -29,6 +32,7 @@ export interface IUnityConfig {
2932
* The url to the unity code file generated by Unity. 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
*/
3438
readonly codeUrl: string;
@@ -37,37 +41,42 @@ export interface IUnityConfig {
3741
* The url where the streaming assets can be found. When using a relative url,
3842
* keep in mind this is relative from the path where your html file is served.
3943
* @public
44+
* @readonly
4045
* @type {string}
4146
*/
4247
readonly streamingAssetsUrl?: string;
4348

4449
/**
4550
* The applications company name.
4651
* @public
52+
* @readonly
4753
* @type {string}
4854
*/
4955
readonly companyName?: string;
5056

5157
/**
5258
* The applications product name.
5359
* @public
60+
* @readonly
5461
* @type {string}
5562
*/
5663
readonly productName?: string;
5764

5865
/**
5966
* The applications product version.
6067
* @public
68+
* @readonly
6169
* @type {string}
6270
*/
6371
readonly productVersion?: string;
6472

6573
/**
6674
* This object allow you to configure WebGLRenderingContext creation options
6775
* which will be pass additional context attributes to the Unity canvas.
68-
* @see https://developer.mozilla.org/en-US/docs/Web/API/WebGLRenderingContext
6976
* @public
77+
* @readonly
7078
* @type {IWebGLContextAttributes}
79+
* @see https://developer.mozilla.org/en-US/docs/Web/API/WebGLRenderingContext
7180
*/
7281
readonly webglContextAttributes?: IWebGLContextAttributes;
7382
}

0 commit comments

Comments
 (0)