From 47ff4c59034524f05b4be0742f60648f68a5e03c Mon Sep 17 00:00:00 2001
From: Christian Engwer <christi@dune-project.org>
Date: Wed, 25 Aug 2010 16:06:36 +0000
Subject: [PATCH] make doxygen happy
[[Imported from SVN: r6105]]
---
dune/common/fvector.hh | 16 ++---
dune/common/mpicollectivecommunication.hh | 24 +++----
dune/common/poolallocator.hh | 4 +-
dune/common/shared_ptr.hh | 3 +
dune/common/sllist.hh | 6 +-
dune/common/tupleutility.hh | 84 +++++++++++++++++++++--
6 files changed, 106 insertions(+), 31 deletions(-)
diff --git a/dune/common/fvector.hh b/dune/common/fvector.hh
index bbb52774d..540de4847 100644
--- a/dune/common/fvector.hh
+++ b/dune/common/fvector.hh
@@ -48,7 +48,7 @@ namespace Dune {
{
/**
\private
- \memberof FieldVector
+ \memberof Dune::FieldVector
*/
template<class K>
inline typename FieldTraits<K>::real_type absreal (const K& k)
@@ -58,7 +58,7 @@ namespace Dune {
/**
\private
- \memberof FieldVector
+ \memberof Dune::FieldVector
*/
template<class K>
inline typename FieldTraits<K>::real_type absreal (const std::complex<K>& c)
@@ -68,7 +68,7 @@ namespace Dune {
/**
\private
- \memberof FieldVector
+ \memberof Dune::FieldVector
*/
template<class K>
inline typename FieldTraits<K>::real_type abs2 (const K& k)
@@ -78,7 +78,7 @@ namespace Dune {
/**
\private
- \memberof FieldVector
+ \memberof Dune::FieldVector
*/
template<class K>
inline typename FieldTraits<K>::real_type abs2 (const std::complex<K>& c)
@@ -88,7 +88,7 @@ namespace Dune {
/**
\private
- \memberof FieldVector
+ \memberof Dune::FieldVector
*/
template<class K, bool isInteger = std::numeric_limits<K>::is_integer>
struct Sqrt
@@ -101,7 +101,7 @@ namespace Dune {
/**
\private
- \memberof FieldVector
+ \memberof Dune::FieldVector
*/
template<class K>
struct Sqrt<K, true>
@@ -114,7 +114,7 @@ namespace Dune {
/**
\private
- \memberof FieldVector
+ \memberof Dune::FieldVector
*/
template<class K>
inline typename FieldTraits<K>::real_type sqrt (const K& k)
@@ -221,7 +221,7 @@ namespace Dune {
DifferenceType position_;
};
- //! Type Traits for Vector::Iterator vs (const Vector)::ConstIterator
+ //! Type Traits for Vector::Iterator vs const Vector::ConstIterator
template<class T>
struct IteratorType
{
diff --git a/dune/common/mpicollectivecommunication.hh b/dune/common/mpicollectivecommunication.hh
index bbb45a4a7..80de0459e 100644
--- a/dune/common/mpicollectivecommunication.hh
+++ b/dune/common/mpicollectivecommunication.hh
@@ -202,19 +202,19 @@ namespace Dune
}
}
- //! @copydoc CollectiveCommunication::rank()
+ //! @copydoc CollectiveCommunication::rank
int rank () const
{
return me;
}
- //! @copydoc CollectiveCommunication::size()
+ //! @copydoc CollectiveCommunication::size
int size () const
{
return procs;
}
- //! @copydoc CollectiveCommunication::sum(T&)
+ //! @copydoc CollectiveCommunication::sum
template<typename T>
T sum (T& in) const // MPI does not know about const :-(
{
@@ -223,14 +223,14 @@ namespace Dune
return out;
}
- //! @copydoc CollectiveCommunication::sum(T*,int)
+ //! @copydoc CollectiveCommunication::sum
template<typename T>
int sum (T* inout, int len) const
{
return allreduce<std::plus<T> >(inout,len);
}
- //! @copydoc CollectiveCommunication::prod(T&)
+ //! @copydoc CollectiveCommunication::prod
template<typename T>
T prod (T& in) const // MPI does not know about const :-(
{
@@ -239,14 +239,14 @@ namespace Dune
return out;
}
- //! @copydoc CollectiveCommunication::prod(T*,int)
+ //! @copydoc CollectiveCommunication::prod
template<typename T>
int prod (T* inout, int len) const
{
return allreduce<std::plus<T> >(inout,len);
}
- //! @copydoc CollectiveCommunication::min(T&)
+ //! @copydoc CollectiveCommunication::min
template<typename T>
T min (T& in) const // MPI does not know about const :-(
{
@@ -255,7 +255,7 @@ namespace Dune
return out;
}
- //! @copydoc CollectiveCommunication::min(T*,int)
+ //! @copydoc CollectiveCommunication::min
template<typename T>
int min (T* inout, int len) const
{
@@ -263,7 +263,7 @@ namespace Dune
}
- //! @copydoc CollectiveCommunication::max(T&)
+ //! @copydoc CollectiveCommunication::max
template<typename T>
T max (T& in) const // MPI does not know about const :-(
{
@@ -272,20 +272,20 @@ namespace Dune
return out;
}
- //! @copydoc CollectiveCommunication::max(T*,int)
+ //! @copydoc CollectiveCommunication::max
template<typename T>
int max (T* inout, int len) const
{
return allreduce<Max<T> >(inout,len);
}
- //! @copydoc CollectiveCommunication::barrier()
+ //! @copydoc CollectiveCommunication::barrier
int barrier () const
{
return MPI_Barrier(communicator);
}
- //! @copydoc CollectiveCommunication::broadcast()
+ //! @copydoc CollectiveCommunication::broadcast
template<typename T>
int broadcast (T* inout, int len, int root) const
{
diff --git a/dune/common/poolallocator.hh b/dune/common/poolallocator.hh
index 7839833df..574fd5f60 100644
--- a/dune/common/poolallocator.hh
+++ b/dune/common/poolallocator.hh
@@ -564,7 +564,7 @@ namespace Dune
}
template<class T, std::size_t s>
- inline void PoolAllocator<T,s>::deallocate(T* p, std::size_t n)
+ inline void PoolAllocator<T,s>::deallocate(pointer p, std::size_t n)
{
for(size_t i=0; i<n; i++)
memoryPool_.free(p++);
@@ -577,7 +577,7 @@ namespace Dune
}
template<class T, std::size_t s>
- inline void PoolAllocator<T,s>::destroy(T* p)
+ inline void PoolAllocator<T,s>::destroy(pointer p)
{
p->~T();
}
diff --git a/dune/common/shared_ptr.hh b/dune/common/shared_ptr.hh
index 60dd38524..a3e590e9b 100644
--- a/dune/common/shared_ptr.hh
+++ b/dune/common/shared_ptr.hh
@@ -60,6 +60,8 @@ namespace Dune
/**
* @brief Constructs a new smart pointer from a preallocated Object.
*
+ * \param pointer Raw pointer to the shared data
+ *
* note: the object must be allocated on the heap and after handing the pointer to
* shared_ptr the ownership of the pointer is also handed to the shared_ptr.
*/
@@ -71,6 +73,7 @@ namespace Dune
* \tparam Deleter This class must by copyconstructable, the copy constructor must not throw an exception
* and it must implement void operator() (T*) const
*
+ * \param pointer Raw pointer to the shared data
* \param deleter A copy of this deleter is stored
*
* note: the object must be allocated on the heap and after handing the pointer to
diff --git a/dune/common/sllist.hh b/dune/common/sllist.hh
index 7f160ea33..12e6395e7 100644
--- a/dune/common/sllist.hh
+++ b/dune/common/sllist.hh
@@ -564,7 +564,7 @@ namespace Dune
{
template<typename T, class A>
- SLList<T,A>::Element::Element(const T& item, Element* next)
+ SLList<T,A>::Element::Element(const MemberType& item, Element* next)
: next_(next), item_(item)
{}
@@ -655,7 +655,7 @@ namespace Dune
}
template<typename T, class A>
- inline void SLList<T,A>::push_back(const T& item)
+ inline void SLList<T,A>::push_back(const MemberType& item)
{
assert(size_>0 || tail_==&beforeHead_);
tail_->next_ = allocator_.allocate(1, 0);
@@ -699,7 +699,7 @@ namespace Dune
}
template<typename T, class A>
- inline void SLList<T,A>::push_front(const T& item)
+ inline void SLList<T,A>::push_front(const MemberType& item)
{
if(tail_ == &beforeHead_) {
// list was empty
diff --git a/dune/common/tupleutility.hh b/dune/common/tupleutility.hh
index cb74f963f..c849ba58e 100644
--- a/dune/common/tupleutility.hh
+++ b/dune/common/tupleutility.hh
@@ -739,11 +739,47 @@ namespace Dune {
*#include <dune/common/utility.hh>
* \endcode
* \tparam TE TypeEvaluator class template.
- * \tparam An Type of extra arguments to pass to \c TE<T>::apply(). It
+ * \tparam A0 Type of extra arguments to pass to \c TE<T>::apply(). It
+ * should not be necessary to specify these template parameters
+ * explicitly since they can be deduced.
+ * \tparam A1 Type of extra arguments to pass to \c TE<T>::apply(). It
+ * should not be necessary to specify these template parameters
+ * explicitly since they can be deduced.
+ * \tparam A2 Type of extra arguments to pass to \c TE<T>::apply(). It
+ * should not be necessary to specify these template parameters
+ * explicitly since they can be deduced.
+ * \tparam A3 Type of extra arguments to pass to \c TE<T>::apply(). It
+ * should not be necessary to specify these template parameters
+ * explicitly since they can be deduced.
+ * \tparam A4 Type of extra arguments to pass to \c TE<T>::apply(). It
+ * should not be necessary to specify these template parameters
+ * explicitly since they can be deduced.
+ * \tparam A5 Type of extra arguments to pass to \c TE<T>::apply(). It
+ * should not be necessary to specify these template parameters
+ * explicitly since they can be deduced.
+ * \tparam A6 Type of extra arguments to pass to \c TE<T>::apply(). It
+ * should not be necessary to specify these template parameters
+ * explicitly since they can be deduced.
+ * \tparam A7 Type of extra arguments to pass to \c TE<T>::apply(). It
+ * should not be necessary to specify these template parameters
+ * explicitly since they can be deduced.
+ * \tparam A8 Type of extra arguments to pass to \c TE<T>::apply(). It
+ * should not be necessary to specify these template parameters
+ * explicitly since they can be deduced.
+ * \tparam A9 Type of extra arguments to pass to \c TE<T>::apply(). It
* should not be necessary to specify these template parameters
* explicitly since they can be deduced.
*
- * \param an Arguments to save references to in the TransformTupleFunctor.
+ * \param a0 Arguments to save references to in the TransformTupleFunctor.
+ * \param a1 Arguments to save references to in the TransformTupleFunctor.
+ * \param a2 Arguments to save references to in the TransformTupleFunctor.
+ * \param a3 Arguments to save references to in the TransformTupleFunctor.
+ * \param a4 Arguments to save references to in the TransformTupleFunctor.
+ * \param a5 Arguments to save references to in the TransformTupleFunctor.
+ * \param a6 Arguments to save references to in the TransformTupleFunctor.
+ * \param a7 Arguments to save references to in the TransformTupleFunctor.
+ * \param a8 Arguments to save references to in the TransformTupleFunctor.
+ * \param a9 Arguments to save references to in the TransformTupleFunctor.
*
* There are overloads of this function (not documented seperately) for any
* number of arguments, up to an implementation-defined arbitrary limit.
@@ -1032,14 +1068,50 @@ namespace Dune {
* \tparam TypeEvaluator Used as the \c TE template argument to
* TransformTupleFunctor internally.
* \tparam Tuple Type of the tuple to transform.
- * \tparam An Types of extra argument to call the transformation
+ * \tparam A0 Types of extra argument to call the transformation
+ * function with.
+ * \tparam A1 Types of extra argument to call the transformation
+ * function with.
+ * \tparam A2 Types of extra argument to call the transformation
+ * function with.
+ * \tparam A3 Types of extra argument to call the transformation
+ * function with.
+ * \tparam A4 Types of extra argument to call the transformation
+ * function with.
+ * \tparam A5 Types of extra argument to call the transformation
+ * function with.
+ * \tparam A6 Types of extra argument to call the transformation
+ * function with.
+ * \tparam A7 Types of extra argument to call the transformation
+ * function with.
+ * \tparam A8 Types of extra argument to call the transformation
+ * function with.
+ * \tparam A9 Types of extra argument to call the transformation
* function with.
*
* \note The \c Tuple and \c An template arguments can be deduced from the
* function arguments, so they can usually be omitted.
*
* \param orig Tuple value to be transformed.
- * \param an Extra argument values to provide to the transformation
+ * \param a0 Extra argument values to provide to the transformation
+ * function.
+ * \param a1 Extra argument values to provide to the transformation
+ * function.
+ * \param a2 Extra argument values to provide to the transformation
+ * function.
+ * \param a3 Extra argument values to provide to the transformation
+ * function.
+ * \param a4 Extra argument values to provide to the transformation
+ * function.
+ * \param a5 Extra argument values to provide to the transformation
+ * function.
+ * \param a6 Extra argument values to provide to the transformation
+ * function.
+ * \param a7 Extra argument values to provide to the transformation
+ * function.
+ * \param a8 Extra argument values to provide to the transformation
+ * function.
+ * \param a9 Extra argument values to provide to the transformation
* function.
*
* This function is overloaded for any number of extra arguments, up to an
@@ -1069,7 +1141,7 @@ namespace Dune {
*
* \note Since transformTuple() takes non-const references to the extra
* arguments, it will only bind to lvalue extra arguments, unless you
- * specify the corresconding template parameter as \c const \s
+ * specify the corresconding template parameter as \c const \c
* SomeType. Specifically this meands that you cannot simply use
* literals or function return values as extra arguments. Providing
* overloads for all possible combinations of rvalue and lvalue extra
@@ -1204,7 +1276,7 @@ namespace Dune {
// Sample TypeEvaluators
//
- //! \c TypeEvaluator to turn a type \T into a reference to \c T
+ //! \c TypeEvaluator to turn a type \c T into a reference to \c T
/**
* This is suitable as the \c TypeEvaluator template parameter for
* ForEachType and transformTuple().
--
GitLab