Skip to content

Commit d21cd44

Browse files
committed
Fix some jsdoc comments.
1 parent fd72820 commit d21cd44

File tree

1 file changed

+6
-3
lines changed
  • extensions/ql-vscode/src

1 file changed

+6
-3
lines changed

extensions/ql-vscode/src/cli.ts

Lines changed: 6 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -462,6 +462,7 @@ export class CodeQLCliServer implements Disposable {
462462
* Gets the RAM setting for the query server.
463463
* @param queryMemoryMb The maximum amount of RAM to use, in MB.
464464
* Leave `undefined` for CodeQL to choose a limit based on the available system memory.
465+
* @param progressReporter The progress reporter to send progress information to.
465466
* @returns String arguments that can be passed to the CodeQL query server,
466467
* indicating how to split the given RAM limit between heap and off-heap memory.
467468
*/
@@ -474,8 +475,8 @@ export class CodeQLCliServer implements Disposable {
474475
}
475476
/**
476477
* Gets the headers (and optionally pagination info) of a bqrs.
477-
* @param config The configuration containing the path to the CLI.
478-
* @param bqrsPath The path to the vqrs.
478+
* @param bqrsPath The path to the bqrs.
479+
* @param pageSize The page size to precompute offsets into the binary file for.
479480
*/
480481
async bqrsInfo(bqrsPath: string, pageSize?: number): Promise<BQRSInfo> {
481482
const subcommandArgs = (
@@ -488,8 +489,10 @@ export class CodeQLCliServer implements Disposable {
488489

489490
/**
490491
* Gets the results from a bqrs.
491-
* @param config The configuration containing the path to the CLI.
492492
* @param bqrsPath The path to the bqrs.
493+
* @param resultSet The result set to get.
494+
* @param pageSize How many results to get.
495+
* @param offset The 0-based index of the first result to get.
493496
*/
494497
async bqrsDecode(bqrsPath: string, resultSet: string, pageSize?: number, offset?: number): Promise<DecodedBqrsChunk> {
495498
const subcommandArgs = [

0 commit comments

Comments
 (0)