C#: Add qlDoc to the restrict predicate.

michaelnebel · michaelnebel · commit e3ecc5a66b43 · 2022-06-15T10:45:32.000+02:00
diff --git a/csharp/ql/src/Telemetry/ExternalApi.qll b/csharp/ql/src/Telemetry/ExternalApi.qll
@@ -132,6 +132,10 @@ module Results<relevantUsagesSig/2 getRelevantUsages> {
       )
   }
 
+  /**
+   * Holds if `api` is being used `usages` times and if it is
+   * in the top results (guarded by resultLimit).
+   */
   predicate restrict(ExternalApi api, int usages) {
     getRelevantUsages(api, usages) and getOrder(api) <= resultLimit()
   }

Original file line number	Diff line number	Diff line change
`@@ -132,6 +132,10 @@ module Results<relevantUsagesSig/2 getRelevantUsages> {`
`132`	`132`	`)`
`133`	`133`	`}`
`134`	`134`
	`135`	`+ /**`
	`136`	+ * Holds if `api` is being used `usages` times and if it is
	`137`	`+ * in the top results (guarded by resultLimit).`
	`138`	`+ */`
`135`	`139`	`predicate restrict(ExternalApi api, int usages) {`
`136`	`140`	`getRelevantUsages(api, usages) and getOrder(api) <= resultLimit()`
`137`	`141`	`}`