From 81b7bec158eab79893487cafce39ac5f4d92db2b Mon Sep 17 00:00:00 2001
From: tpietzsch <tobias.pietzsch@gmail.com>
Date: Tue, 7 Jul 2020 21:48:47 +0200
Subject: [PATCH] MovingAverage: javadoc

---
 src/main/java/bdv/util/MovingAverage.java | 5 +++++
 1 file changed, 5 insertions(+)

diff --git a/src/main/java/bdv/util/MovingAverage.java b/src/main/java/bdv/util/MovingAverage.java
index c3db8230..8ea05bd5 100644
--- a/src/main/java/bdv/util/MovingAverage.java
+++ b/src/main/java/bdv/util/MovingAverage.java
@@ -2,6 +2,11 @@ package bdv.util;
 
 import java.util.Arrays;
 
+/**
+ * Maintains a moving average over the last {@code width} values {@link #add
+ * added}. The average can be {@link #init initialized} to some value (or starts
+ * as 0, i.e., as if {@code width} 0 values had been added)
+ */
 public class MovingAverage
 {
 	private final double[] values;
-- 
GitLab