From 68859991b88d827a8523179f44fb2848e9fae15e Mon Sep 17 00:00:00 2001
From: Christian Engwer <christi@dune-project.org>
Date: Mon, 9 May 2011 12:53:49 +0000
Subject: [PATCH] Basic documentation of math.hh
[[Imported from SVN: r6438]]
---
dune/common/math.hh | 19 ++++++++++++++++---
1 file changed, 16 insertions(+), 3 deletions(-)
diff --git a/dune/common/math.hh b/dune/common/math.hh
index 0ec9e7025..b21f986bf 100644
--- a/dune/common/math.hh
+++ b/dune/common/math.hh
@@ -8,14 +8,26 @@
namespace Dune
{
+ /**
+ \brief Provides commonly used mathematical constants.
+
+ a struct that is specilized for types repesenting real or complex
+ numbers. I provides commonly used mathematical constants with the
+ required accuary for the specified type.
+ */
template< class Field >
struct MathematicalConstants;
+ /**
+ \brief Standard implementation of MathematicalConstants.
+ This implementation will work with all build in floating point
+ types. It provides
- // StandardMathematicalConstants
- // -----------------------------
+ * e as std::exp(1.0)
+ * pi as std::acos(-1.0)
+ */
template< class T >
struct StandardMathematicalConstants
{
@@ -33,7 +45,7 @@ namespace Dune
};
-
+#ifndef DOXYGEN
// MathematicalConstants for float
// -------------------------------
@@ -61,6 +73,7 @@ namespace Dune
struct MathematicalConstants< long double >
: public StandardMathematicalConstants< long double >
{};
+#endif // DOXYGEN
}
--
GitLab