Skip to content

Commit 65695c3

Browse files
committed
Add comments
1 parent a4f9411 commit 65695c3

1 file changed

Lines changed: 7 additions & 1 deletion

File tree

  • extensions/ql-vscode/src

extensions/ql-vscode/src/cli.ts

Lines changed: 7 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -608,7 +608,13 @@ export class CodeQLCliServer implements Disposable {
608608

609609
return await this.runCodeQlCliCommand(['database', 'unbundle'], subcommandArgs, `Extracting ${archivePath} to directory ${target}`);
610610
}
611-
611+
612+
/**
613+
* Uses a .qhelp file to generate Query Help documentation in a specified format.
614+
* @param pathToQlhelp The path to the .qhelp file
615+
* @param format The format in which the query help should be generated {@link https://codeql.github.com/docs/codeql-cli/manual/generate-query-help/#cmdoption-codeql-generate-query-help-format}
616+
* @param outputDirectory The output directory for the generated file
617+
*/
612618
async generateQueryHelp(pathToQlhelp:string, format: string, outputDirectory?: string): Promise<string> {
613619
const subcommandArgs = [];
614620
subcommandArgs.push('--format', format);

0 commit comments

Comments
 (0)