Skip to content

Commit 87369a7

Browse files
chore: Fix JSDocs
1 parent 9125032 commit 87369a7

File tree

1 file changed

+6
-4
lines changed

1 file changed

+6
-4
lines changed

typings/interfaces.ts

+6-4
Original file line numberDiff line numberDiff line change
@@ -168,7 +168,7 @@ declare module NativeScriptDoctor {
168168
projectDir?: string;
169169

170170
/**
171-
* The runtime version against which the validation is executed. In case this parameter is passed, it takes predescences over the projectDir argument.
171+
* The runtime version against which the validation is executed. In case this parameter is passed, it takes precedence over the projectDir argument.
172172
*/
173173
androidRuntimeVersion?: string;
174174
}
@@ -180,10 +180,12 @@ declare module NativeScriptDoctor {
180180
/**
181181
* Checks if a local build can be executed on the current machine.
182182
* @param {string} platform The platform for which to check if local build is possible.
183-
* @param {string} runtimeVersion @optional The runtime version against which the validation is executed. In case this parameter is passed, it takes predescences over the projectDir argument.
183+
* @param {string} projectDir @optional The project directory. Used to determine the Android Runtime version and validate the Java compiler version against it.
184+
* If it is not passed or the project does not have Android runtime, this validation is skipped.
185+
* @param {string} runtimeVersion @optional The runtime version against which the validation is executed. In case this parameter is passed, it takes precedence over the projectDir argument.
184186
* @return {Promise<boolean>} true if local build can be executed for the provided platform.
185187
*/
186-
canExecuteLocalBuild(platform: string, runtimeVersion?: string): Promise<boolean>;
188+
canExecuteLocalBuild(platform: string, projectDir?: string, runtimeVersion?: string): Promise<boolean>;
187189

188190
/**
189191
* Executes all checks for the current environment and returns the warnings from each check.
@@ -445,7 +447,7 @@ declare module NativeScriptDoctor {
445447
* @param {string} installedJavaVersion The version of javac to check.
446448
* @param {string} projectDir @optional The project directory. Used to determine the Android Runtime version and validate the Java compiler version against it.
447449
* If it is not passed or the project does not have Android runtime, this validation is skipped.
448-
* @param {string} runtimeVersion @optional The runtime version against which the validation is executed. In case this parameter is passed, it takes predescences over the projectDir argument.
450+
* @param {string} runtimeVersion @optional The runtime version against which the validation is executed. In case this parameter is passed, it takes precedence over the projectDir argument.
449451
* @return {NativeScriptDoctor.IWarning[]} An array of errors from the validation checks. If there are no errors will return [].
450452
*/
451453
validateJavacVersion(installedJavaVersion: string, projectDir?: string, runtimeVersion?: string): NativeScriptDoctor.IWarning[];

0 commit comments

Comments
 (0)