Skip to content

Commit

Permalink
Fix javadoc in Aggregations class (open-telemetry#886)
Browse files Browse the repository at this point in the history
Signed-off-by: Bogdan Cristian Drutu <[email protected]>
  • Loading branch information
bogdandrutu authored and DotSpy committed Feb 21, 2020
1 parent dcea940 commit 759d242
Showing 1 changed file with 11 additions and 7 deletions.
Original file line number Diff line number Diff line change
Expand Up @@ -28,41 +28,45 @@
public class Aggregations {

/**
* Aggregation that calculates sum of recorded measurements.
* Returns an {@code Aggregation} that calculates sum of recorded measurements.
*
* @return an {@code Aggregation} that calculates sum of recorded measurements.
* @since 0.1.0
*/
public static Aggregation sum() {
return Sum.INSTANCE;
}

/**
* Aggregation that calculates count of recorded measurements (the number of recorded
* measurements).
* Returns an {@code Aggregation} that calculates count of recorded measurements (the number of
* recorded measurements).
*
* @return an {@code Aggregation} that calculates count of recorded measurements (the number of
* recorded * measurements).
* @since 0.1.0
*/
public static Aggregation count() {
return Count.INSTANCE;
}

/**
* Aggregation that calculates distribution stats on recorded measurements. Distribution includes
* sum, count, histogram, and sum of squared deviations.
* Returns an {@code Aggregation} that calculates distribution stats on recorded measurements.
* Distribution includes sum, count, histogram, and sum of squared deviations.
*
* <p>The boundaries for the buckets in the underlying histogram needs to be sorted.
*
* @param bucketBoundaries bucket boundaries to use for distribution.
* @return a new {@code Distribution}.
* @return an {@code Aggregation} that calculates distribution stats on recorded measurements.
* @since 0.1.0
*/
public static Aggregation distributionWithExplicitBounds(Double... bucketBoundaries) {
return new Distribution(bucketBoundaries);
}

/**
* Aggregation that calculates the last value of all recorded measurements.
* Returns an {@code Aggregation} that calculates the last value of all recorded measurements.
*
* @return an {@code Aggregation} that calculates the last value of all recorded measurements.
* @since 0.1.0
*/
public static Aggregation lastValue() {
Expand Down

0 comments on commit 759d242

Please sign in to comment.