Loading...
Searching...
No Matches
Dune::ImplementationDefined Struct Reference
Common

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(Dune::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
Dune::ImplementationDefined
Dummy struct used for documentation purposes.
Definition documentation.hh:42
Dune::type
Dune::AlwaysFalse
template which always yields a false value
Definition typetraits.hh:124

See also
  implementationDefined

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

- documentation.hh