From 4f8137b449f97741dc7a2b80eb61900ef791c648 Mon Sep 17 00:00:00 2001
From: "joseph.lizier" <joseph.lizier@gmail.com>
Date: Wed, 13 Aug 2014 15:20:00 +0000
Subject: [PATCH] Minor corrections to Javadocs for the continuous package

---
 .../measures/continuous/ChannelCalculator.java             | 7 ++++---
 .../measures/continuous/ChannelCalculatorCommon.java       | 5 -----
 .../measures/continuous/TransferEntropyCalculator.java     | 4 ++--
 .../kraskov/MutualInfoCalculatorMultiVariateKraskov.java   | 4 ++--
 4 files changed, 8 insertions(+), 12 deletions(-)

diff --git a/java/source/infodynamics/measures/continuous/ChannelCalculator.java b/java/source/infodynamics/measures/continuous/ChannelCalculator.java
index b63ebd2..62c1620 100755
--- a/java/source/infodynamics/measures/continuous/ChannelCalculator.java
+++ b/java/source/infodynamics/measures/continuous/ChannelCalculator.java
@@ -19,8 +19,9 @@
 package infodynamics.measures.continuous;
 
 /**
- * A basic interface for calculators computing measures on a univariate <i>channel</i> from a
- * source to a destination time-series (i.e. mutual information and transfer entropy).
+ * A basic interface for calculators computing measures on a univariate <i>channel</i>
+ * for continuous (ie double[]) data from a
+ * source to a destination time-series (ie mutual information and transfer entropy).
  * In the following, we refer to the abstract measure computed by this calculator
  * as the <i>"channel measure"</i>.
  * 
@@ -38,7 +39,7 @@ package infodynamics.measures.continuous;
  * 
  * @author Joseph Lizier (<a href="joseph.lizier at gmail.com">email</a>,
  * <a href="http://lizier.me/joseph/">www</a>)
- * @see ChannelCalculator
+ * @see ChannelCalculatorCommon
  */
 public interface ChannelCalculator extends ChannelCalculatorCommon {
 
diff --git a/java/source/infodynamics/measures/continuous/ChannelCalculatorCommon.java b/java/source/infodynamics/measures/continuous/ChannelCalculatorCommon.java
index 15256ec..4a97430 100755
--- a/java/source/infodynamics/measures/continuous/ChannelCalculatorCommon.java
+++ b/java/source/infodynamics/measures/continuous/ChannelCalculatorCommon.java
@@ -129,7 +129,6 @@ public abstract interface ChannelCalculatorCommon {
 	 * Compute the channel measure from the previously-supplied samples.
 	 * 
 	 * @return the estimate of the channel measure
-	 * @throws Exception
 	 */
 	public double computeAverageLocalOfObservations() throws Exception;
 
@@ -149,7 +148,6 @@ public abstract interface ChannelCalculatorCommon {
 	 *  to create a single "time-series" return array.</p>
 	 *  
 	 * @return the "time-series" of local channel measure values.
-	 * @throws Exception
 	 */
 	public double[] computeLocalOfPreviousObservations() throws Exception;
 
@@ -177,7 +175,6 @@ public abstract interface ChannelCalculatorCommon {
 	 * @return the distribution of channel measure scores under this null hypothesis.
 	 * @see "J.T. Lizier, 'JIDT: An information-theoretic
 	 *    toolkit for studying the dynamics of complex systems', 2014."
-	 * @throws Exception
 	 */
 	public EmpiricalMeasurementDistribution computeSignificance(int numPermutationsToCheck) throws Exception;
 	
@@ -244,8 +241,6 @@ public abstract interface ChannelCalculatorCommon {
 	 * </p>
 	 * 
 	 * @return the number of samples to be used for the PDFs
-	 * @throws Exception
 	 */
 	public int getNumObservations() throws Exception;
-
 }
diff --git a/java/source/infodynamics/measures/continuous/TransferEntropyCalculator.java b/java/source/infodynamics/measures/continuous/TransferEntropyCalculator.java
index f278dfa..2e6d673 100755
--- a/java/source/infodynamics/measures/continuous/TransferEntropyCalculator.java
+++ b/java/source/infodynamics/measures/continuous/TransferEntropyCalculator.java
@@ -54,14 +54,14 @@ package infodynamics.measures.continuous;
  * 							{@link #addObservations(double[], double[], int, int)}, then</li>
  * 						<li>{@link #finaliseAddObservations()};</li>
  * 					</ol></li>
- * 			</ul>
+ * 			</ul></li>
  * 		<li>Compute the required quantities, being one or more of:
  * 			<ul>
  * 				<li>the average TE: {@link #computeAverageLocalOfObservations()};</li>
  * 				<li>the local TE values for these samples: {@link #computeLocalOfPreviousObservations()}</li>
  * 				<li>local TE values for a specific set of samples:
  * 				{@link #computeLocalUsingPreviousObservations(double[], double[])} </li>
- * 				<li>the distribution of MI values under the null hypothesis
+ * 				<li>the distribution of TE values under the null hypothesis
  * 					of no relationship between source and
  * 					destination values: {@link #computeSignificance(int)} or
  * 					{@link #computeSignificance(int[][])}.</li>
diff --git a/java/source/infodynamics/measures/continuous/kraskov/MutualInfoCalculatorMultiVariateKraskov.java b/java/source/infodynamics/measures/continuous/kraskov/MutualInfoCalculatorMultiVariateKraskov.java
index 2d19305..a6de83a 100755
--- a/java/source/infodynamics/measures/continuous/kraskov/MutualInfoCalculatorMultiVariateKraskov.java
+++ b/java/source/infodynamics/measures/continuous/kraskov/MutualInfoCalculatorMultiVariateKraskov.java
@@ -263,12 +263,12 @@ public abstract class MutualInfoCalculatorMultiVariateKraskov
 	 *  (with PDFs computed using all of the previously supplied observation sets).</p>
 	 *  
 	 * <p>If the samples were supplied via a single call such as
-	 * {@link #setObservations(double[])},
+	 * {@link #setObservations(double[][], double[][])},
 	 * then the return value is a single time-series of local
 	 * channel measure values corresponding to these samples.</p>
 	 * 
 	 * <p>Otherwise where disjoint time-series observations were supplied using several 
-	 *  calls such as {@link addObservations(double[])}
+	 *  calls such as {@link #addObservations(double[][], double[][])}
 	 *  then the local values for each disjoint observation set will be appended here
 	 *  to create a single "time-series" return array.</p>
 	 *