hohn/codeql
1
0
Fork 0
mirror of https://github.com/github/codeql.git synced 2025-12-16 16:53:25 +01:00
Code Issues Packages Projects Releases Wiki Activity

Reformat docstrings

Browse Source
This commit is contained in:
Anna Railton
2021-11-18 11:23:44 +00:00
committed by annarailton
parent 4351d9e861
commit c7f96928dc
1 changed files with 19 additions and 11 deletions
Download Patch File Download Diff File Expand all files Collapse all files

30
javascript/ql/experimental/adaptivethreatmodeling/lib/experimental/adaptivethreatmodeling/EndpointFeatures.qll
View File

@@ -31,10 +31,9 @@ private string getTokenFeature(DataFlow::Node endpoint, string featureName) {
result = unique(string x | x = FunctionBodies::getBodyTokenFeatureForEntity(entity)) result = unique(string x | x = FunctionBodies::getBodyTokenFeatureForEntity(entity))
) )
or or
// A feature containing natural language tokens from the neighborhood around the endpoint
// A feature containing natural language tokens from the neighborhood around the endpoint // (limited to within the function that encloses the endpoint), in the order they appear
// (limited to within the function that encloses the endpoint), in the order they appear // in the source code.
// in the source code.
exists(Raw::AstNode rootNode, DatabaseFeatures::AstNode rootNodeWrapped | exists(Raw::AstNode rootNode, DatabaseFeatures::AstNode rootNodeWrapped |
featureName = "neighborhoodBody" and featureName = "neighborhoodBody" and
rootNode = NeighborhoodBodies::getNeighborhoodAstNode(Raw::astNode(endpoint.getAstNode())) and rootNode = NeighborhoodBodies::getNeighborhoodAstNode(Raw::astNode(endpoint.getAstNode())) and
@@ -171,13 +170,18 @@ module FunctionBodies {
} }
} }
/** This module provides functionality for getting the local neighborhood around an AST node within its enclosing function body, providing a locally-scoped version of the `enclosingFunctionBody` feature. */ /**
* This module provides functionality for getting the local neighborhood around an AST node within
* its enclosing function body, providing a locally-scoped version of the `enclosingFunctionBody` feature.
*/
module NeighborhoodBodies { module NeighborhoodBodies {
/** /**
* Return the ancestor of the input AST node that has the largest number of descendants (i.e. the node nearest the * Return the ancestor of the input AST node that has the largest number of descendants (i.e. the
* root) but has no more than 128 descendants. * node nearest the root) but has no more than `maxNumDescendants` descendants.
* TODO: Maybe instead of a threshold on number of descendants, we should instead have a threshold on the number of *
* leaves in the subtree, which is a closer approximation to the number of tokens in the subtree. * TODO: Maybe instead of a threshold on number of descendants, we should instead have a threshold
* on the number of leaves in the subtree, which is a closer approximation to the number of tokens
* in the subtree.
*/ */
Raw::AstNode getNeighborhoodAstNode(Raw::AstNode node) { Raw::AstNode getNeighborhoodAstNode(Raw::AstNode node) {
if getNumDescendents(node.getParentNode()) > maxNumDescendants() if getNumDescendents(node.getParentNode()) > maxNumDescendants()
@@ -189,7 +193,8 @@ module NeighborhoodBodies {
int getNumDescendents(Raw::AstNode node) { result = count(node.getAChildNode*()) } int getNumDescendents(Raw::AstNode node) { result = count(node.getAChildNode*()) }
/** /**
* Holds if `childNode` is an AST node under `rootNode` and `token` is a node attribute associated with `childNode`. Note that only AST leaves have node attributes. * Holds if `childNode` is an AST node under `rootNode` and `token` is a node attribute associated
* with `childNode`. Note that only AST leaves have node attributes.
* *
* TODO we may need to restrict `rootNode` to be a neighborhood root to avoid a potentially big result set. * TODO we may need to restrict `rootNode` to be a neighborhood root to avoid a potentially big result set.
*/ */
@@ -279,7 +284,10 @@ private module AccessPaths {
Boolean() { this = true or this = false } Boolean() { this = true or this = false }
} }
/** Get the access path for the node. This includes structural information like `member`, `param`, and `functionalarg` if `includeStructuralInfo` is true. */ /**
* Get the access path for the node. This includes structural information like `member`, `param`,
* and `functionalarg` if `includeStructuralInfo` is true.
*/
predicate accessPaths( predicate accessPaths(
API::Node node, Boolean includeStructuralInfo, string accessPath, string apiName API::Node node, Boolean includeStructuralInfo, string accessPath, string apiName
) { ) {