Add documentation to ExternalApiUsage fields
This commit is contained in:
@@ -11,13 +11,24 @@ export type ExternalApiUsage = {
|
||||
*/
|
||||
library: string;
|
||||
/**
|
||||
* Contains the full method signature, e.g. `org.sql2o.Connection#createQuery(String)`
|
||||
* A unique signature that can be used to identify this external API usage.
|
||||
*
|
||||
* The signature contains the package name, type name, method name, and method parameters
|
||||
* in the form "packageName.typeName#methodName(methodParameters)".
|
||||
* e.g. `org.sql2o.Connection#createQuery(String)`
|
||||
*/
|
||||
signature: string;
|
||||
packageName: string;
|
||||
typeName: string;
|
||||
methodName: string;
|
||||
/**
|
||||
* The method parameters, including enclosing parentheses, e.g. `(String, String)`
|
||||
*/
|
||||
methodParameters: string;
|
||||
/**
|
||||
* Is this method already supported by CodeQL standard libraries.
|
||||
* If so, there is no need for the user to model it themselves.
|
||||
*/
|
||||
supported: boolean;
|
||||
usages: Call[];
|
||||
};
|
||||
|
||||
Reference in New Issue
Block a user