Skip to content

Commit b2ca3d2

Browse files
committed
JS: improve PoI::alertQuery docstring
1 parent a386d2d commit b2ca3d2

File tree

1 file changed

+13
-1
lines changed
  • javascript/ql/src/experimental/PoI

1 file changed

+13
-1
lines changed

javascript/ql/src/experimental/PoI/PoI.qll

Lines changed: 13 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -272,8 +272,20 @@ module PoI {
272272

273273
/**
274274
* An alert query for a point of interest.
275+
276+
* Should be used as:
277+
*
278+
* ```
279+
* query predicate problems = PoI::alertQuery/6;`
280+
* ```
281+
*
282+
* Or alternatively:
275283
*
276-
* Should be used as: `query predicate problems = PoI::alertQuery/6;`
284+
* ```
285+
* from Locatable l1line, string msg, Node l2, string s2, Node l3, string s3
286+
* where PoI::alertQuery(l1line, msg, l2, s2, l3, s3)
287+
* select l1line, msg, l2, s2, l3, s3
288+
* ```
277289
*
278290
* Note that some points of interest do not have auxiliary
279291
* locations, so `l2`,`l3`, `s2`, `s3` may have placeholder values.

0 commit comments

Comments
 (0)