Documentation improvements

Author: tiferet

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

@@ -31,8 +31,9 @@ abstract class EndpointCharacteristic extends string {
    * This predicate describes what the characteristic tells us about an endpoint.
    *
    * Params:
-   * endpointClass: Class 0 is the negative class, containing non-sink endpoints. Each positive int corresponds to a
-   * single sink type.
+   * endpointClass: The sink type. Each EndpointType has a predicate getEncoding, which specifies the classifier
+   * class for this sink type. Class 0 is the negative class (non-sink). Each positive int corresponds to a single
+   * sink type.
    * isPositiveIndicator: If true, this characteristic indicates that this endpoint _is_ a member of the class; if
    * false, it indicates that it _isn't_ a member of the class.
    * confidence: A float in [0, 1], which tells us how strong an indicator this characteristic is for the endpoint

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

@@ -16,6 +16,11 @@ newtype TEndpointType =
 abstract class EndpointType extends TEndpointType {
   abstract string getDescription();
 
+  /**
+   * The integer representation of this endpoint type. This integer representation specifies the class number used
+   * by the endpoint scoring model (the classifier) to represent this endpoint type. Class 0 is the negative class
+   * (non-sink). Each positive int corresponds to a single sink type.
+   */
   abstract int getEncoding();
 
   string toString() { result = getDescription() }