From ae124b2a91e0191adb332e0895c893b0896e68bd Mon Sep 17 00:00:00 2001
From: Christian Engwer <christi@dune-project.org>
Date: Fri, 5 Oct 2012 09:12:01 +0000
Subject: [PATCH] [doc] fix \code blocks documentation.hh
[[Imported from SVN: r7020]]
---
dune/common/documentation.hh | 40 +++++++++++++++++++-----------------
1 file changed, 21 insertions(+), 19 deletions(-)
diff --git a/dune/common/documentation.hh b/dune/common/documentation.hh
index dad773f61..e783a9c44 100644
--- a/dune/common/documentation.hh
+++ b/dune/common/documentation.hh
@@ -10,38 +10,40 @@
namespace Dune {
- //! Dummy struct used for documentation purposes
/**
+ * \brief Dummy struct used for documentation purposes
+ *
* This struct can be used for documenting interfaces. One example would
* be:
* \code
- // Traits class that determines some property for some other type T
- template<class T>
- class SomeTraits {
- dune_static_assert(AlwaysFalse<T>::value,
- "Sorry, SomeTraits must be specialized for all types");
- public:
- // The type of some property of T
- typedef ImplementationDefined type;
- };
- *#ifndef DOXYGEN
- template<>
- struct SomeTraits<int>
- typedef ... type;
- };
- // ...
- *#endif // DOXYGEN
+ * // Traits class that determines some property for some other type T
+ * template<class T>
+ * class SomeTraits {
+ * dune_static_assert(AlwaysFalse<T>::value,
+ * "Sorry, SomeTraits must be specialized for all types");
+ * public:
+ * // The type of some property of T
+ * typedef ImplementationDefined type;
+ * };
+ * #ifndef DOXYGEN
+ * template<>
+ * struct SomeTraits<int>
+ * typedef ... type;
+ * };
+ * // ...
+ * #endif // DOXYGEN
* \endcode
*
* \sa implementationDefined
*/
struct ImplementationDefined {};
- //! Dummy integral value used for documentation purposes
/**
+ * \brief Dummy integral value used for documentation purposes
+ *
* \var Dune::implementationDefined
* \code
- *#include <dune/common/documentation.hh>
+ * #include <dune/common/documentation.hh>
* \endcode
*
* \sa ImplementationDefined
--
GitLab