Dune Core Modules (2.6.0)

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:
Creative Commons License   |  Legal Statements / Impressum  |  generated with Hugo v0.80.0 (Jun 1, 22:28, 2023)