aboutsummaryrefslogtreecommitdiffhomepage
diff options
context:
space:
mode:
authorGravatar Jitse Niesen <jitse@maths.leeds.ac.uk>2010-12-27 15:07:11 +0000
committerGravatar Jitse Niesen <jitse@maths.leeds.ac.uk>2010-12-27 15:07:11 +0000
commit8db9acbc163c497e1d8d1450b1b6c7cf35687ab9 (patch)
treeccec2e45b747e4414bda25e291faf62a178f5dfc
parent840c4e1ab5151ca8288721c10c1d92e35df61581 (diff)
Move doxygen comments for EIGEN_NO_DEBUG from source to I14.
This reverts changeset 76fbe94279bda314e717cb3f98b46b253d081993 . Benoit and I agree that my approach there (to use doxygen comments) pollutes the code too much.
-rw-r--r--Eigen/Core8
-rw-r--r--Eigen/src/Core/util/Macros.h13
-rw-r--r--doc/I11_Aliasing.dox2
-rw-r--r--doc/I14_PreprocessorDirectives.dox6
-rw-r--r--doc/QuickReference.dox2
5 files changed, 8 insertions, 23 deletions
diff --git a/Eigen/Core b/Eigen/Core
index d88cdc1a9..a1ac99784 100644
--- a/Eigen/Core
+++ b/Eigen/Core
@@ -32,13 +32,7 @@
// then include this file where all our macros are defined. It's really important to do it first because
// it's where we do all the alignment settings (platform detection and honoring the user's will if he
// defined e.g. EIGEN_DONT_ALIGN) so it needs to be done before we do anything with vectorization.
-#ifndef EIGEN_PARSED_BY_DOXYGEN
- #include "src/Core/util/Macros.h"
-#else
- namespace Eigen { // for some reason Doxygen needs this namespace
- #include "src/Core/util/Macros.h"
- }
-#endif
+#include "src/Core/util/Macros.h"
// if alignment is disabled, then disable vectorization. Note: EIGEN_ALIGN is the proper check, it takes into
// account both the user's will (EIGEN_DONT_ALIGN) and our own platform checks
diff --git a/Eigen/src/Core/util/Macros.h b/Eigen/src/Core/util/Macros.h
index 2e1f905b7..1de2c6f26 100644
--- a/Eigen/src/Core/util/Macros.h
+++ b/Eigen/src/Core/util/Macros.h
@@ -109,19 +109,6 @@
#define EIGEN_DEBUG_VAR(x) std::cerr << #x << " = " << x << std::endl;
-#ifdef EIGEN_PARSED_BY_DOXYGEN
- /** \def EIGEN_NO_DEBUG
- * \ingroup Core_Module
- * \brief If defined, Eigen's assertions are disabled.
- * \details Disabling run-time assertions improves the performance, but it is dangerous because the
- * assertions guard against programming errors. By default, the EIGEN_NO_DEBUG macro is not defined and
- * Eigen's run-time assertions are thus enabled. However, if the NDEBUG macro is defined (this is a
- * standard C++ macro which disables all asserts), then the EIGEN_NO_DEBUG macro will also be defined, and
- * so Eigen's assertions will also be disabled.
- */
- #define EIGEN_NO_DEBUG
-#endif
-
#ifdef NDEBUG
# ifndef EIGEN_NO_DEBUG
# define EIGEN_NO_DEBUG
diff --git a/doc/I11_Aliasing.dox b/doc/I11_Aliasing.dox
index b5b5a3b59..7c111991c 100644
--- a/doc/I11_Aliasing.dox
+++ b/doc/I11_Aliasing.dox
@@ -73,7 +73,7 @@ Assertion `(!internal::check_transpose_aliasing_selector<Scalar,internal::blas_t
\endverbatim
The user can turn Eigen's run-time assertions like the one to detect this aliasing problem off by defining the
-#EIGEN_NO_DEBUG macro, and the above program was compiled with this macro turned off in order to illustrate the
+EIGEN_NO_DEBUG macro, and the above program was compiled with this macro turned off in order to illustrate the
aliasing problem. See \ref TopicAssertions for more information about Eigen's run-time assertions.
diff --git a/doc/I14_PreprocessorDirectives.dox b/doc/I14_PreprocessorDirectives.dox
index 3fd811cc7..0c8804020 100644
--- a/doc/I14_PreprocessorDirectives.dox
+++ b/doc/I14_PreprocessorDirectives.dox
@@ -3,7 +3,11 @@ namespace Eigen {
/** \page TopicPreprocessorDirectives Preprocessor directives
You can control some aspects of Eigen by defining the following preprocessor tokens them before including any of Eigen's headers.
- - \b #EIGEN_NO_DEBUG disables Eigen assertions. Like NDEBUG but only affects Eigen's assertions.
+ - \b EIGEN_NO_DEBUG If defined, Eigen's assertions are disabled. Disabling run-time assertions improves the
+ performance, but it is dangerous because the assertions guard against programming errors. By default, the
+ EIGEN_NO_DEBUG macro is not defined and Eigen's run-time assertions are thus enabled. However, if the
+ NDEBUG macro is defined (this is a standard C++ macro which disables all asserts), then the EIGEN_NO_DEBUG
+ macro will also be defined, and so Eigen's assertions will also be disabled.
- \b EIGEN_DONT_VECTORIZE disables explicit vectorization when defined.
- \b EIGEN_UNROLLING_LIMIT defines the maximal instruction counts to enable meta unrolling of loops. Set it to zero to disable unrolling. The default is 100.
- \b EIGEN_DEFAULT_TO_ROW_MAJOR the default storage order for matrices becomes row-major instead of column-major.
diff --git a/doc/QuickReference.dox b/doc/QuickReference.dox
index e657f1a7c..62c327107 100644
--- a/doc/QuickReference.dox
+++ b/doc/QuickReference.dox
@@ -176,7 +176,7 @@ vector[i] vector.y()
vector.w()
\endcode</td><td>\code
matrix(i,j)
-\endcode</td><td class="note">Range checking is disabled if \n NDEBUG or #EIGEN_NO_DEBUG is defined</td></tr>
+\endcode</td><td class="note">Range checking is disabled if \n NDEBUG or EIGEN_NO_DEBUG is defined</td></tr>
<tr class="alt"><td>Coeff access without \n range checking</td>
<td>\code