Skip to content

Commit b02f1c8

Browse files
codeql-cicodeql-ci
authored
Merge pull request github#7679 from erik-krogh/ql-doc-style
Approved by esbena
2 parents 2287b6e + 5780161 commit b02f1c8

File tree

18 files changed

+52
-52
lines changed

18 files changed

+52
-52
lines changed

‎javascript/ql/lib/semmle/javascript/Externs.qll

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -544,7 +544,7 @@ class ExternalInterface extends ExternalType {
544544
}
545545

546546
/**
547-
* Externs definition for the Function object.
547+
* The externs definition for the Function object.
548548
*
549549
* Example:
550550
*
@@ -561,7 +561,7 @@ class FunctionExternal extends ExternalConstructor {
561561
}
562562

563563
/**
564-
* Externs definition for the Object object.
564+
* The externs definition for the Object object.
565565
*
566566
* Example:
567567
*
@@ -578,7 +578,7 @@ class ObjectExternal extends ExternalConstructor {
578578
}
579579

580580
/**
581-
* Externs definition for the Array object.
581+
* The externs definition for the Array object.
582582
*
583583
* Example:
584584
*

‎javascript/ql/lib/semmle/javascript/Promises.qll

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -707,7 +707,7 @@ private module DynamicImportSteps {
707707
*/
708708
module Promisify {
709709
/**
710-
* Gets a call to a `promisifyAll` function.
710+
* A call to a `promisifyAll` function.
711711
* E.g. `require("bluebird").promisifyAll(...)`.
712712
*/
713713
class PromisifyAllCall extends DataFlow::CallNode {
@@ -721,7 +721,7 @@ module Promisify {
721721
}
722722

723723
/**
724-
* Gets a call to a `promisify` function.
724+
* A call to a `promisify` function.
725725
* E.g. `require("util").promisify(...)`.
726726
*/
727727
class PromisifyCall extends DataFlow::CallNode {

‎javascript/ql/lib/semmle/javascript/StringOps.qll

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -512,7 +512,7 @@ module StringOps {
512512
}
513513

514514
/**
515-
* One of the operands in a string concatenation.
515+
* An operand in a string concatenation.
516516
*
517517
* Examples:
518518
* ```

‎javascript/ql/lib/semmle/javascript/TypeScript.qll

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1644,7 +1644,7 @@ class EnumMember extends ASTNode, @enum_member {
16441644
}
16451645

16461646
/**
1647-
* Scope induced by an interface declaration, containing the type parameters declared on the interface.
1647+
* A scope induced by an interface declaration, containing the type parameters declared on the interface.
16481648
*
16491649
* Interfaces that do not declare type parameters have no scope object.
16501650
*/
@@ -1653,7 +1653,7 @@ class InterfaceScope extends @interface_scope, Scope {
16531653
}
16541654

16551655
/**
1656-
* Scope induced by a type alias declaration, containing the type parameters declared the the alias.
1656+
* A scope induced by a type alias declaration, containing the type parameters declared the the alias.
16571657
*
16581658
* Type aliases that do not declare type parameters have no scope object.
16591659
*/
@@ -1662,14 +1662,14 @@ class TypeAliasScope extends @type_alias_scope, Scope {
16621662
}
16631663

16641664
/**
1665-
* Scope induced by a mapped type expression, containing the type parameter declared as part of the type.
1665+
* A scope induced by a mapped type expression, containing the type parameter declared as part of the type.
16661666
*/
16671667
class MappedTypeScope extends @mapped_type_scope, Scope {
16681668
override string toString() { result = "mapped type scope" }
16691669
}
16701670

16711671
/**
1672-
* Scope induced by an enum declaration, containing the names of its enum members.
1672+
* A scope induced by an enum declaration, containing the names of its enum members.
16731673
*
16741674
* Initializers of enum members are resolved in this scope since they can reference
16751675
* previously-defined enum members by their unqualified name.
@@ -2637,7 +2637,7 @@ class TypeofType extends Type, @typeof_type {
26372637
}
26382638

26392639
/**
2640-
* One of two values indicating if a signature is a function or constructor signature.
2640+
* A value indicating if a signature is a function or constructor signature.
26412641
*/
26422642
class SignatureKind extends string {
26432643
SignatureKind() { this = "function" or this = "constructor" }

‎javascript/ql/lib/semmle/javascript/dataflow/TypeTracking.qll

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -15,7 +15,7 @@ private import semmle.javascript.internal.CachedStages
1515
private newtype TTypeTracker = MkTypeTracker(Boolean hasCall, OptionalPropertyName prop)
1616

1717
/**
18-
* Summary of the steps needed to track a value to a given dataflow node.
18+
* A summary of the steps needed to track a value to a given dataflow node.
1919
*
2020
* This can be used to track objects that implement a certain API in order to
2121
* recognize calls to that API. Note that type-tracking does not by itself provide a
@@ -182,7 +182,7 @@ module TypeTracker {
182182
private newtype TTypeBackTracker = MkTypeBackTracker(Boolean hasReturn, OptionalPropertyName prop)
183183

184184
/**
185-
* Summary of the steps needed to back-track a use of a value to a given dataflow node.
185+
* A summary of the steps needed to back-track a use of a value to a given dataflow node.
186186
*
187187
* This can be used to track callbacks that are passed to a certain API call, and are
188188
* therefore expected to be called with a certain type of value.

‎javascript/ql/lib/semmle/javascript/frameworks/Babel.qll

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -49,7 +49,7 @@ module Babel {
4949
}
5050

5151
/**
52-
* Configuration object for a Babel plugin.
52+
* A configuration object for a Babel plugin.
5353
*/
5454
class Plugin extends JSONValue {
5555
Config cfg;

‎javascript/ql/lib/semmle/javascript/frameworks/Cheerio.qll

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -29,7 +29,7 @@ module Cheerio {
2929
DataFlow::SourceNode cheerioRef() { result = cheerioRef(DataFlow::TypeTracker::end()) }
3030

3131
/**
32-
* Creation of `cheerio` object, a collection of virtual DOM elements
32+
* A creation of `cheerio` object, a collection of virtual DOM elements
3333
* with an interface similar to that of a jQuery object.
3434
*/
3535
class CheerioObjectCreation extends DataFlow::SourceNode instanceof CheerioObjectCreation::Range {
@@ -88,7 +88,7 @@ module Cheerio {
8888
}
8989

9090
/**
91-
* Definition of a DOM attribute through `cheerio`.
91+
* A definition of a DOM attribute through `cheerio`.
9292
*/
9393
class AttributeDef extends DOM::AttributeDefinition {
9494
DataFlow::CallNode call;
@@ -105,7 +105,7 @@ module Cheerio {
105105
}
106106

107107
/**
108-
* XSS sink through `cheerio`.
108+
* An XSS sink through `cheerio`.
109109
*/
110110
class XssSink extends Xss::DomBasedXss::Sink {
111111
XssSink() {

‎javascript/ql/lib/semmle/javascript/frameworks/ExpressModules.qll

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -16,7 +16,7 @@ module ExpressLibraries {
1616
}
1717

1818
/**
19-
* Header produced by a route handler of the "x-frame-options" module.
19+
* A header produced by a route handler of the "x-frame-options" module.
2020
*/
2121
class XFrameOptionsRouteHandlerHeader extends HTTP::ImplicitHeaderDefinition {
2222
XFrameOptionsRouteHandlerHeader() { this instanceof XFrameOptionsRouteHandler }
@@ -29,7 +29,7 @@ module ExpressLibraries {
2929
}
3030

3131
/**
32-
* Route handler from the "x-frame-options" module.
32+
* A route handler from the "x-frame-options" module.
3333
*/
3434
class XFrameOptionsRouteHandler extends HTTP::RouteHandler {
3535
XFrameOptionsRouteHandler() {
@@ -43,7 +43,7 @@ module ExpressLibraries {
4343
}
4444

4545
/**
46-
* Header produced by a route handler of the "frameguard" module.
46+
* A header produced by a route handler of the "frameguard" module.
4747
*/
4848
class FrameGuardRouteHandlerHeader extends HTTP::ImplicitHeaderDefinition {
4949
FrameGuardRouteHandlerHeader() { this instanceof FrameGuardRouteHandler }
@@ -56,7 +56,7 @@ module ExpressLibraries {
5656
}
5757

5858
/**
59-
* Route handler from the "frameguard" module.
59+
* A route handler from the "frameguard" module.
6060
*/
6161
class FrameGuardRouteHandler extends HTTP::RouteHandler {
6262
FrameGuardRouteHandler() { this = DataFlow::moduleImport("frameguard").getAnInvocation() }
@@ -68,7 +68,7 @@ module ExpressLibraries {
6868
}
6969

7070
/**
71-
* Header produced by a route handler of the "helmet" module.
71+
* A header produced by a route handler of the "helmet" module.
7272
*/
7373
class HelmetRouteHandlerHeader extends HTTP::ImplicitHeaderDefinition {
7474
HelmetRouteHandlerHeader() { this instanceof HelmetRouteHandler }
@@ -81,7 +81,7 @@ module ExpressLibraries {
8181
}
8282

8383
/**
84-
* Route handler from the "helmet" module.
84+
* A route handler from the "helmet" module.
8585
*/
8686
class HelmetRouteHandler extends HTTP::RouteHandler {
8787
HelmetRouteHandler() {

‎javascript/ql/lib/semmle/javascript/frameworks/Firebase.qll

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -179,7 +179,7 @@ module Firebase {
179179
/** Gets a data flow node holding a `RefBuilder` object. */
180180
DataFlow::SourceNode ref() { result = refBuilder(DataFlow::TypeTracker::end()) }
181181

182-
/** Gets a call that registers a listener on a `RefBuilder`, such as `ref.onCreate(...)`. */
182+
/** A call that registers a listener on a `RefBuilder`, such as `ref.onCreate(...)`. */
183183
class RefBuilderListenCall extends DataFlow::MethodCallNode {
184184
RefBuilderListenCall() {
185185
this = ref().getAMethodCall() and

‎javascript/ql/lib/semmle/javascript/frameworks/Next.qll

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -44,7 +44,7 @@ module NextJS {
4444
}
4545

4646
/**
47-
* User defined path parameter in `Next.js`.
47+
* A user defined path parameter in `Next.js`.
4848
*/
4949
class NextParams extends RemoteFlowSource {
5050
NextParams() {

0 commit comments

Comments
 (0)