Skip to content

Commit b526ff4

Browse files
committed
Contextual queries: update doc comments
1 parent 3bb10d8 commit b526ff4

File tree

1 file changed

+15
-2
lines changed

1 file changed

+15
-2
lines changed

extensions/ql-vscode/src/contextual/templateProvider.ts

Lines changed: 15 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -27,12 +27,11 @@ import { createInitialQueryInfo, QueryWithResults } from '../run-queries-shared'
2727
import { QueryRunner } from '../queryRunner';
2828

2929
/**
30-
* Run templated CodeQL queries to find definitions and references in
30+
* Runs templated CodeQL queries to find definitions in
3131
* source-language files. We may eventually want to find a way to
3232
* generalize this to other custom queries, e.g. showing dataflow to
3333
* or from a selected identifier.
3434
*/
35-
3635
export class TemplateQueryDefinitionProvider implements DefinitionProvider {
3736
private cache: CachedOperation<LocationLink[]>;
3837

@@ -77,6 +76,12 @@ export class TemplateQueryDefinitionProvider implements DefinitionProvider {
7776
}
7877
}
7978

79+
/**
80+
* Runs templated CodeQL queries to find references in
81+
* source-language files. We may eventually want to find a way to
82+
* generalize this to other custom queries, e.g. showing dataflow to
83+
* or from a selected identifier.
84+
*/
8085
export class TemplateQueryReferenceProvider implements ReferenceProvider {
8186
private cache: CachedOperation<FullLocationLink[]>;
8287

@@ -131,6 +136,10 @@ type QueryWithDb = {
131136
dbUri: Uri
132137
};
133138

139+
/**
140+
* Run templated CodeQL queries to produce AST information for
141+
* source-language files.
142+
*/
134143
export class TemplatePrintAstProvider {
135144
private cache: CachedOperation<QueryWithDb>;
136145

@@ -222,6 +231,10 @@ export class TemplatePrintAstProvider {
222231
}
223232
}
224233

234+
/**
235+
* Run templated CodeQL queries to produce CFG information for
236+
* source-language files.
237+
*/
225238
export class TemplatePrintCfgProvider {
226239
private cache: CachedOperation<[Uri, Record<string, string>] | undefined>;
227240

0 commit comments

Comments
 (0)