From 93ac406d56a9363d6e174eda387ac8325d97d67e Mon Sep 17 00:00:00 2001
From: Christian Engwer <christi@dune-project.org>
Date: Thu, 24 Sep 2009 07:07:27 +0000
Subject: [PATCH] implorve documentation
[[Imported from SVN: r5594]]
---
common/float_cmp.hh | 12 ++++++++++++
1 file changed, 12 insertions(+)
diff --git a/common/float_cmp.hh b/common/float_cmp.hh
index def77d63e..364db6230 100644
--- a/common/float_cmp.hh
+++ b/common/float_cmp.hh
@@ -144,6 +144,8 @@ namespace Dune {
/**
* @tparam T Type of the values to compare
* @tparam style How to compare. This defaults to defaultCmpStyle.
+ * @param first left operand of equals operation
+ * @param second right operand of equals operation
* @param epsilon The epsilon to use in the comparison
*/
template <class T, CmpStyle style /*= defaultCmpStyle*/>
@@ -154,6 +156,8 @@ namespace Dune {
/**
* @tparam T Type of the values to compare
* @tparam style How to compare. This defaults to defaultCmpStyle.
+ * @param first left operand of not-equal operation
+ * @param second right operand of not-equal operation
* @param epsilon The epsilon to use in the comparison
* @return !eq(first, second, epsilon)
*/
@@ -165,6 +169,8 @@ namespace Dune {
/**
* @tparam T Type of the values to compare
* @tparam style How to compare. This defaults to defaultCmpStyle.
+ * @param first left operand of greater-than operation
+ * @param second right operand of greater-than operation
* @param epsilon The epsilon to use in the comparison
* @return ne(first, second, epsilon) && first > second
*
@@ -179,6 +185,8 @@ namespace Dune {
/**
* @tparam T Type of the values to compare
* @tparam style How to compare. This defaults to defaultCmpStyle.
+ * @param first left operand of less-than operation
+ * @param second right operand of less-than operation
* @param epsilon The epsilon to use in the comparison
* @return ne(first, second, epsilon) && first < second
*
@@ -193,6 +201,8 @@ namespace Dune {
/**
* @tparam T Type of the values to compare
* @tparam style How to compare. This defaults to defaultCmpStyle.
+ * @param first left operand of greater-or-equals operation
+ * @param second right operand of greater-or-equals operation
* @param epsilon The epsilon to use in the comparison
* @return eq(first, second, epsilon) || first > second
*
@@ -207,6 +217,8 @@ namespace Dune {
/**
* @tparam T Type of the values to compare
* @tparam style How to compare. This defaults to defaultCmpStyle.
+ * @param first left operand of less-or-equals operation
+ * @param second right operand of less-or-equals operation
* @param epsilon The epsilon to use in the comparison
* @return eq(first, second) || first > second
*
--
GitLab