WIF - Combinators - Documentation enhancement

plnyrich · plnyrich · commit 990395514348 · 2024-08-01T12:34:27.000+02:00
diff --git a/include/wif/combinators/binaryDSTCombinator.hpp b/include/wif/combinators/binaryDSTCombinator.hpp
@@ -31,7 +31,7 @@ class BinaryDSTCombinator : public Combinator {
 	 * together and the resulting probability of the positive hypothesis is returned.
 	 *
 	 * @param valuesToCombine vector of doubles to combine
-	 * @return double DST combination of input values
+	 * @return double belief of the positive hypothesis after DST combination
 	 */
 	double combine(const std::vector<double>& valuesToCombine) override;
 };

Original file line number	Diff line number	Diff line change
`@@ -31,7 +31,7 @@ class BinaryDSTCombinator : public Combinator {`
`31`	`31`	`* together and the resulting probability of the positive hypothesis is returned.`
`32`	`32`	`*`
`33`	`33`	`* @param valuesToCombine vector of doubles to combine`
`34`		`- * @return double DST combination of input values`
	`34`	`+ * @return double belief of the positive hypothesis after DST combination`
`35`	`35`	`*/`
`36`	`36`	`double combine(const std::vector<double>& valuesToCombine) override;`
`37`	`37`	`};`