hohn/codeql
1
0
Fork 0
mirror of https://github.com/github/codeql.git synced 2026-04-27 17:55:19 +02:00
Code Issues Packages Projects Releases Wiki Activity

Java: tidy QLDoc in Extents.qll

Browse Source
This commit is contained in:
yh-semmle
2019-10-12 18:06:43 -04:00
parent e3f828c588
commit d165ce95f2
1 changed files with 9 additions and 5 deletions
Download Patch File Download Diff File Expand all files Collapse all files

14
java/ql/src/Metrics/Internal/Extents.qll
View File

@@ -1,15 +1,19 @@
import java
/*
/**
* Provides classes that modify the default location information
* of `RefType`s and `Callable`s to cover their full extent.
*
* When this library is imported, the `hasLocationInfo` predicate of
* `Callable` and `RefTypes` is overridden to specify their entire range
* instead of just the range of their name. The latter can still be
* obtained by invoking the `getLocation()` predicate.
*
* The full ranges are required for the purpose of associating a violation
* with an individual `Callable` or `RefType` as opposed to a whole `File`.
* The full ranges may be used to determine whether a given location
* (for example, the location of an alert) is contained within the extent
* of a `Callable` or `RefType`.
*/
import java
/**
* A Callable whose `hasLocationInfo` is overridden to specify its entire range
* including the body (if any), as opposed to the location of its name only.