Skip to content

Commit 996ff56

Browse files
committed
chore: update description of @return
1 parent 29ddae9 commit 996ff56

File tree

1 file changed

+5
-5
lines changed

1 file changed

+5
-5
lines changed

src/commands.ts

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@ import { mapArguments, objectify, spawnMakensis, splitCommands } from './util.ts
66
* Returns usage information for a command, or list all commands
77
* @param command - an NSIS command
88
* @param compilerOptions - compiler options
9-
* @returns - usage description
9+
* @returns command help for the specified command, or all commands
1010
*/
1111
export async function commandHelp(
1212
command = '',
@@ -57,7 +57,7 @@ export async function compile(
5757
/**
5858
* Returns information about which options were used to compile MakeNSIS
5959
* @param compilerOptions - compiler options
60-
* @returns - compiler options
60+
* @returns header information used for MakeNSIS compilation
6161
*/
6262
export async function headerInfo(
6363
compilerOptions: Makensis.CompilerOptions = {},
@@ -72,7 +72,7 @@ export async function headerInfo(
7272
/**
7373
* Returns MakeNSIS software license
7474
* @param compilerOptions - compiler options
75-
* @returns - compiler license
75+
* @returns MakeNSIS license text
7676
*/
7777
export async function license(
7878
compilerOptions: Makensis.CompilerOptions = {},
@@ -86,7 +86,7 @@ export async function license(
8686
/**
8787
* Returns directory where NSIS is installed to
8888
* @param compilerOptions - compiler options
89-
* @returns - NSIS directory
89+
* @returns NSIS directory path or object with `nsisdir` property
9090
*/
9191
export async function nsisDir(
9292
compilerOptions: Makensis.CompilerOptions = {},
@@ -113,7 +113,7 @@ export async function nsisDir(
113113
/**
114114
* Returns version of MakeNSIS
115115
* @param compilerOptions - compiler options
116-
* @returns - compiler version
116+
* @returns NSIS version string or object with `version` property
117117
*/
118118
export async function version(
119119
compilerOptions: Makensis.CompilerOptions = {},

0 commit comments

Comments
 (0)