From 7e190981eee3e65e5c47f958fefb8733ea23493c Mon Sep 17 00:00:00 2001 From: Andre Holzner Date: Tue, 14 Nov 2017 15:15:51 +0100 Subject: [PATCH] added documentation for parameter precision in classes CalculationContext and Context. No code changes --- .../daqexpert/reasoning/base/CalculationContext.java | 5 +++++ .../rcms/utilities/daqexpert/reasoning/base/Context.java | 4 ++++ 2 files changed, 9 insertions(+) diff --git a/src/main/java/rcms/utilities/daqexpert/reasoning/base/CalculationContext.java b/src/main/java/rcms/utilities/daqexpert/reasoning/base/CalculationContext.java index 4fa23a89..c81cb67b 100644 --- a/src/main/java/rcms/utilities/daqexpert/reasoning/base/CalculationContext.java +++ b/src/main/java/rcms/utilities/daqexpert/reasoning/base/CalculationContext.java @@ -21,6 +21,11 @@ public class CalculationContext implements Serializable { private String unit; private DecimalFormat df; + + /** @param precision specifies the number of digits to include after the decimal + * point when converting the values to string format + * (see {@link java.text.DecimalFormat#setMaximumFractionDigits(int) }) + */ public CalculationContext(String unit, int precision) { if (unit == null) { diff --git a/src/main/java/rcms/utilities/daqexpert/reasoning/base/Context.java b/src/main/java/rcms/utilities/daqexpert/reasoning/base/Context.java index 9877f34c..70544fcc 100644 --- a/src/main/java/rcms/utilities/daqexpert/reasoning/base/Context.java +++ b/src/main/java/rcms/utilities/daqexpert/reasoning/base/Context.java @@ -46,6 +46,10 @@ public boolean registerForStatistics(String key, Number value){ return registerForStatistics(key, value,"",1); } + /** @param precision specifies the number of digits to include after the decimal + * point when converting the values to string format + * (see {@link CalculationContext#CalculationContext(java.lang.String, int) }) + */ public boolean registerForStatistics(String key, Number value, String unit, int precision) { if (!contextForCalculations.containsKey(key)) { contextForCalculations.put(key, new CalculationContext(unit, precision));