diff --git a/include/ConflictSet.h b/include/ConflictSet.h index 78d073d..9a3439d 100644 --- a/include/ConflictSet.h +++ b/include/ConflictSet.h @@ -90,18 +90,19 @@ struct __attribute__((__visibility__("default"))) ConflictSet { /** Experimental! */ struct MetricsV1 { - /** A null-terminated string with static lifetime. Matches the regex - * [a-zA-Z_:][a-zA-Z0-9_:]* + /** A null-terminated string with static lifetime. Identifies this metric. + * Matches the regex [a-zA-Z_:][a-zA-Z0-9_:]* */ const char *name; - /** A null-terminated string with static lifetime. May contain any sequence - * of UTF-8 characters (after the metric name), but the backslash and the - * line feed characters have to be escaped as \\ and \n, respectively. + /** A null-terminated string with static lifetime. Describes this metric. + * May contain any sequence of UTF-8 characters, but the backslash and the + * line feed characters are escaped as \\ and \n, respectively. */ const char *help; /** Counters are >= 0 and non-decreasing. Gauges are any value. */ enum Type { Counter, Gauge } type; - /** Get the most up-to-date value available for this metric. Thread-safe. */ + /** Get the most up-to-date (best effort) value for this metric. + * Thread-safe. */ double getValue() const; /** @private */ void *p;