dune-common  2.5.1
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
Dune::ImplementationDefined Struct Reference

Dummy struct used for documentation purposes. More...

#include <dune/common/documentation.hh>

Detailed Description

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 {
* static_assert(Std::to_false_type<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
*
See Also
implementationDefined

The documentation for this struct was generated from the following file: