From 5d5a69ece42bb350a5c416c19cc6208eeaef6525 Mon Sep 17 00:00:00 2001
From: Jorrit Fahlke <joe@dune-project.org>
Date: Sat, 3 Oct 2009 17:13:18 +0000
Subject: [PATCH] * Introduce AlwaysFalse, a helper template for
dune_static_assert(). * Turn STRIP_CODE_COMMENTS on in Doxyfile.in.
Otherwise, doxygen seems to remove comments from \code...\endcode blocks.
This has the side effect that comments are no longer stripped from the
source code doxygen presents via the web interface, which is probably a
good thing in itself.
[[Imported from SVN: r5616]]
---
common/static_assert.hh | 55 +++++++++++++++++++++++++++++++++++++++++
doc/doxygen/Doxyfile.in | 2 +-
2 files changed, 56 insertions(+), 1 deletion(-)
diff --git a/common/static_assert.hh b/common/static_assert.hh
index dd1b64b01..45cc977ac 100644
--- a/common/static_assert.hh
+++ b/common/static_assert.hh
@@ -85,6 +85,13 @@ template<int x> struct static_assert_test {};
dune_static_assert((is_same<bool,int>::value), "error msg"); // false, will trigger a compile time error
\endcode
+ \note
+ \code
+ dune_static_assert(false, "error");
+ \endcode
+ will usually not do what was intended, see Dune::AlwaysFalse for a way to
+ achieve the desired result.
+
Be aware that...
<ol>
<li>dune_static_assert is not in the namespace Dune</li>
@@ -104,6 +111,54 @@ template<int x> struct static_assert_test {};
> CPPMAGIC_JOIN (dune_static_assert_typedef_, __LINE__)
#endif
+namespace Dune {
+ //! template which always yields a false value
+ /**
+ * \tparam T Some type. It sould be a type expression involving template
+ * parameters of the class or function using AlwaysFalse.
+ *
+ * Suppose you have a template class. You want to document the required
+ * members of this class in the non-specialized template, but you know that
+ * actually instantiating the non-specialized template is an error. You
+ * can try something like this:
+ * \code
+ template<typename T>
+ struct Traits {
+ dune_static_assert(false,
+ "Instanciating this non-specialized template is an "
+ "error. You should use one of the specializations "
+ "instead.");
+ //! The type used to frobnicate T
+ typedef void FrobnicateType;
+ };
+ * \endcode
+ * This will trigger dune_static_assert() as soon as the compiler read the
+ * definition for the Traits template, since it knows that "false" can
+ * never become true, no matter what the template parameters of Traits are.
+ * As a workaround you can use AlwaysFalse: replace <tt>false</tt> by
+ * <tt>AlwaysFalse<T>::value</tt>, like this:
+ * \code
+ template<typename T>
+ struct Traits {
+ dune_static_assert(AlwaysFalse<T>::value,
+ "Instanciating this non-specialized template is an "
+ "error. You should use one of the specializations "
+ "instead.");
+ //! The type used to frobnicate T
+ typedef void FrobnicateType;
+ };
+ * \endcode
+ * Since there might be an specialization of AlwaysFalse for template
+ * parameter T, the compiler cannot trigger dune_static_assert() until the
+ * type of T is known, that is, until Traits<T> is instantiated.
+ */
+ template<typename T>
+ struct AlwaysFalse {
+ //! always a false value
+ static const bool value = false;
+ };
+} // namespace Dune
+
/* @} */
#endif
diff --git a/doc/doxygen/Doxyfile.in b/doc/doxygen/Doxyfile.in
index 2538303ba..9e89a0a17 100644
--- a/doc/doxygen/Doxyfile.in
+++ b/doc/doxygen/Doxyfile.in
@@ -570,7 +570,7 @@ INLINE_SOURCES = NO
# doxygen to hide any special comment blocks from generated source code
# fragments. Normal C and C++ comments will always remain visible.
-STRIP_CODE_COMMENTS = YES
+STRIP_CODE_COMMENTS = NO
# If the REFERENCED_BY_RELATION tag is set to YES (the default)
# then for each documented function all documented
--
GitLab