Skip to content
Snippets Groups Projects
Commit ae124b2a authored by Christian Engwer's avatar Christian Engwer
Browse files

[doc]

fix \code blocks documentation.hh

[[Imported from SVN: r7020]]
parent 28f18c12
No related branches found
No related tags found
No related merge requests found
......@@ -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
......
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment