/usr/include/dune/common/documentation.hh is in libdune-common-dev 2.5.1-1.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 | // -*- tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 2 -*-
// vi: set et ts=4 sw=2 sts=2:
#ifndef DUNE_COMMON_DOCUMENTATION_HH
#define DUNE_COMMON_DOCUMENTATION_HH
/** \file
\brief Documentation related stuff
*/
namespace Dune {
/**
* \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 {
* 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
* \endcode
*
* \sa implementationDefined
*/
struct ImplementationDefined {};
/**
* \brief Dummy integral value used for documentation purposes
*
* \var Dune::implementationDefined
* \code
* #include <dune/common/documentation.hh>
* \endcode
*
* \sa ImplementationDefined
*/
enum { implementationDefined };
}
#endif // DUNE_COMMON_DOCUMENTATION_HH
|