JS: Update doc comment

asgerf · asgerf · commit 8da96ed40350 · 2022-05-24T11:57:30.000+02:00
diff --git a/javascript/ql/lib/semmle/javascript/ApiGraphs.qll b/javascript/ql/lib/semmle/javascript/ApiGraphs.qll
@@ -28,11 +28,11 @@ module API {
    * The most basic use of API graphs is typically as follows:
    * 1. Start with `API::moduleImport` for the relevant library.
    * 2. Follow up with a chain of accessors such as `getMember` describing how to get to the relevant API function.
-   * 3. Map the resulting API graph nodes to data-flow nodes, using `getAnImmediateUse` or `getARhs`.
+   * 3. Map the resulting API graph nodes to data-flow nodes, using `getASource` or `getASink`.
    *
    * For example, a simplified way to get arguments to `underscore.extend` would be
    * ```codeql
-   * API::moduleImport("underscore").getMember("extend").getParameter(0).getARhs()
+   * API::moduleImport("underscore").getMember("extend").getParameter(0).getASink()
    * ```
    *
    * The most commonly used accessors are `getMember`, `getParameter`, and `getReturn`.

Original file line number	Diff line number	Diff line change
`@@ -28,11 +28,11 @@ module API {`
`28`	`28`	`* The most basic use of API graphs is typically as follows:`
`29`	`29`	* 1. Start with `API::moduleImport` for the relevant library.
`30`	`30`	* 2. Follow up with a chain of accessors such as `getMember` describing how to get to the relevant API function.
`31`		- * 3. Map the resulting API graph nodes to data-flow nodes, using `getAnImmediateUse` or `getARhs`.
	`31`	+ * 3. Map the resulting API graph nodes to data-flow nodes, using `getASource` or `getASink`.
`32`	`32`	`*`
`33`	`33`	* For example, a simplified way to get arguments to `underscore.extend` would be
`34`	`34`	* ```codeql
`35`		`- * API::moduleImport("underscore").getMember("extend").getParameter(0).getARhs()`
	`35`	`+ * API::moduleImport("underscore").getMember("extend").getParameter(0).getASink()`
`36`	`36`	* ```
`37`	`37`	`*`
`38`	`38`	* The most commonly used accessors are `getMember`, `getParameter`, and `getReturn`.