Skip to content
Snippets Groups Projects
Commit 06191c85 authored by Christoph Grüninger's avatar Christoph Grüninger
Browse files

Slightly improve Doxygen documentation.

parent 5aae3fe9
No related branches found
No related tags found
No related merge requests found
......@@ -71,14 +71,15 @@
* \code
template<typename T> struct Class {
void frob() DUNE_DEPRECATED {}
};
}; // 1)
template<typename T> struct Class {
void DUNE_DEPRECATED frob() {}
};
}; // 2)
template<typename T> struct Class {
DUNE_DEPRECATED void frob() {}
};
}; // 3)
* \endcode
* With g++ only 2) emits a warning for templated member functions.
*/
#define DUNE_DEPRECATED
#else // defined(HAS_ATTRIBUTE_DEPRECATED)
......@@ -154,15 +155,16 @@
* - Member functions
* \code
template<typename T> struct Class {
void frob() DUNE_DEPRECATED_MSG("frogs() are beautiful from now on") {}
};
void frob() DUNE_DEPRECATED_MSG("use frog") {}
}; // 1)
template<typename T> struct Class {
void DUNE_DEPRECATED_MSG("frogs() are beautiful from now on") frob() {}
};
void DUNE_DEPRECATED_MSG("use frog") frob() {}
}; // 2)
template<typename T> struct Class {
DUNE_DEPRECATED_MSG("frogs() are beautiful from now on") void frob() {}
};
DUNE_DEPRECATED_MSG("use frog") void frob() {}
}; // 3)
* \endcode
* With g++ only 2) emits a warning for templated member functions.
*/
#define DUNE_DEPRECATED_MSG(text) DUNE_DEPRECATED
#else // defined(HAS_ATTRIBUTE_DEPRECATED_MSG)
......
......@@ -35,6 +35,7 @@ namespace Dune {
/** @brief computes the dot product for fundamental data types according to Petsc's VectDot function: dot(a,b) := std::conj(a)*b
*
* @see http://www.mcs.anl.gov/petsc/petsc-current/docs/manualpages/Vec/VecDot.html#VecDot
* @param a
* @param b
* @return conj(a)*b
*/
......
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment