From 66b698383e5677a251ca42826a1fd5263537a659 Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?Lars=20Blu=CC=88mke?= <lbl@informatik.uni-kiel.de>
Date: Wed, 13 Apr 2016 11:21:48 +0200
Subject: [PATCH] Updated javadoc comments
---
.../filter/sink/CPUUtilizationDisplayFilter.java | 16 ++++++++++++++--
1 file changed, 14 insertions(+), 2 deletions(-)
diff --git a/src/main/java/kieker/analysis/plugin/filter/sink/CPUUtilizationDisplayFilter.java b/src/main/java/kieker/analysis/plugin/filter/sink/CPUUtilizationDisplayFilter.java
index bc1bf3d7..ea885996 100644
--- a/src/main/java/kieker/analysis/plugin/filter/sink/CPUUtilizationDisplayFilter.java
+++ b/src/main/java/kieker/analysis/plugin/filter/sink/CPUUtilizationDisplayFilter.java
@@ -28,7 +28,7 @@ import kieker.common.record.system.CPUUtilizationRecord;
import teetime.stage.basic.AbstractFilter;
/**
- * This is a filter which accepts {@link CPUUtilizationRecord} instances and provides different views to visualize them.
+ * This is a filter which accepts {@link CPUUtilizationRecord} instances and provides different views (XYPlot or MeterGauge) to visualize them.
*
* @author Bjoern Weissenfels, Nils Christian Ehmke, Lars Erik Bluemke
*
@@ -51,7 +51,19 @@ public class CPUUtilizationDisplayFilter extends AbstractFilter<CPUUtilizationRe
private final TimeUnit recordsTimeUnit;
- public CPUUtilizationDisplayFilter(final int numberOfEntries, final Long[] warningIntervals, final TimeUnit recordsTimeUnit) {
+ /**
+ * Creates a new instance of this filter.
+ *
+ * @param numberOfEntries
+ * Maximal number of entries in a XYPlot
+ * @param warningIntervals
+ * The intervals for the colors displayed in a XYPlot
+ * @param recordsTimeUnit
+ * Time unit to interpret the timestamp of a record passed to the input port
+ * @see kieker.analysis.display.MeterGauge
+ * @see kieker.analysis.display.XYPlot
+ */
+ public CPUUtilizationDisplayFilter(final int numberOfEntries, final Number[] warningIntervals, final TimeUnit recordsTimeUnit) {
this.numberOfEntries = numberOfEntries;
this.warningIntervals = warningIntervals;
this.recordsTimeUnit = recordsTimeUnit;
--
GitLab