Skip to content

Commit fadbdc1

Browse files
committed
Documentation improvements suggested by Andrew
1 parent 8b11e98 commit fadbdc1

File tree

1 file changed

+9
-6
lines changed

1 file changed

+9
-6
lines changed

javascript/ql/experimental/adaptivethreatmodeling/lib/experimental/adaptivethreatmodeling/EndpointCharacteristics.qll

Lines changed: 9 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -30,12 +30,15 @@ abstract class EndpointCharacteristic extends string {
3030
/**
3131
* This predicate describes what the characteristic tells us about an endpoint.
3232
*
33-
* Params:
34-
* endpointClass: Class 0 is the negative class. Each positive int corresponds to a single sink type.
35-
* isPositiveIndicator: Does this characteristic indicate this endpoint _is_ a member of the class, or that it
36-
* _isn't_ a member of the class?
37-
* confidence: A number in [0, 1], which tells us how strong an indicator this characteristic is for the endpoint
38-
* belonging / not belonging to the given class.
33+
* Params:
34+
* endpointClass: Class 0 is the negative class, containing non-sink endpoints. Each positive int corresponds to a
35+
* single sink type.
36+
* isPositiveIndicator: If true, this characteristic indicates that this endpoint _is_ a member of the class; if
37+
* false, it indicates that it _isn't_ a member of the class.
38+
* confidence: A float in [0, 1], which tells us how strong an indicator this characteristic is for the endpoint
39+
* belonging / not belonging to the given class. A confidence near zero means this characterestic is a very weak
40+
* indicator of whether or not the endpoint belongs to the class. A confidence of 1 means that all endpoints with
41+
* this characteristic difinitively do/don't belong to the class.
3942
*/
4043
abstract predicate getImplications(
4144
EndpointType endpointClass, boolean isPositiveIndicator, float confidence

0 commit comments

Comments
 (0)