Improved JavaDoc for createDataSet.
@@ -34,6 +34,19 @@ import hudson.util.DataSetBuilder;
public abstract class SeriesBuilder {
private static final int A_DAY_IN_MSEC = 24 * 3600 * 1000;
+ /**
+ * Creates a new data set for a category graph from the specified static analysis results. The results (provided by
+ * an iterator) must be sorted by build number in descending order. I.e., the iterator starts with the newest build
+ * and stops at the oldest build. The actual series for each result needs to be implemented by sub classes by
+ * overriding method {@link #computeSeries}.
+ *
+ * @param configuration
+ * configures the data set (how many results should be process, etc.)
+ * @param results
+ * the ordered static analysis results
+ *
+ * @return the created data set
+ */
public CategoryDataset createDataSet(final GraphConfiguration configuration,
final Iterable<? extends StaticAnalysisRun> results) {
CategoryDataset dataSet;
