dune-common 2.1.1
|
Dummy struct used for documentation purposes. More...
#include <dune/common/documentation.hh>
Dummy struct used for documentation purposes.
This struct can be used for documenting interfaces. One example would be:
// 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