Skip to content

Commit fee32d3

Browse files
committed
Elaborate on qldoc for API::EntryPoint
1 parent be65b9b commit fee32d3

File tree

2 files changed

+13
-2
lines changed

2 files changed

+13
-2
lines changed

javascript/ql/lib/semmle/javascript/ApiGraphs.qll

Lines changed: 6 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -371,8 +371,12 @@ module API {
371371
/**
372372
* An API entry point.
373373
*
374-
* Extend this class to define additional API entry points other than modules.
375-
* Typical examples include global variables.
374+
* By default, API graph nodes are only created for nodes that come from an external
375+
* library or escape into an external library. The points where values are cross the boundary
376+
* between codebases are called "entry points".
377+
*
378+
* Imports and exports are considered entry points by default, but additional entry points may
379+
* be added by extending this class. Typical examples include global variables.
376380
*/
377381
abstract class EntryPoint extends string {
378382
bindingset[this]

ruby/ql/lib/codeql/ruby/ApiGraphs.qll

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -273,6 +273,13 @@ module API {
273273

274274
/**
275275
* An API entry point.
276+
*
277+
* By default, API graph nodes are only created for nodes that come from an external
278+
* library or escape into an external library. The points where values are cross the boundary
279+
* between codebases are called "entry points".
280+
*
281+
* Anything in the global scope is considered to be an entry point, but
282+
* additional entry points may be added by extending this class.
276283
*/
277284
abstract class EntryPoint extends string {
278285
bindingset[this]

0 commit comments

Comments
 (0)