Skip to content
Snippets Groups Projects
Commit bc3a7648 authored by Adrian Burri's avatar Adrian Burri
Browse files

Added comments so that (hopefully) every class appears in the documentation

[[Imported from SVN: r132]]
parent 0dfb5af4
No related branches found
No related tags found
No related merge requests found
......@@ -151,6 +151,8 @@ namespace Dune {
};
//! \todo Please doc me!
template<typename T>
class MPITraits<ParallelLocalIndex<T> >
{
......@@ -161,6 +163,7 @@ namespace Dune {
};
//! \todo Please doc me!
template<typename TG, typename TA>
class MPITraits<IndexPair<TG,ParallelLocalIndex<TA> > >
{
......@@ -558,6 +561,7 @@ namespace Dune {
typedef typename Map::iterator ConstRealIterator;
//! \todo Please doc me!
iterator(const RealIterator& iter, const ConstRealIterator& end, TG& index)
: iter_(iter), end_(end), index_(index)
{
......@@ -566,10 +570,12 @@ namespace Dune {
++iter_;
}
//! \todo Please doc me!
iterator(const iterator& other)
: iter_(other.iter_), end_(other.end_), index_(other.index_)
{ }
//! \todo Please doc me!
iterator& operator++()
{
++iter_;
......@@ -580,26 +586,31 @@ namespace Dune {
return *this;
}
//! \todo Please doc me!
const std::pair<int,RemoteIndex>& operator*() const
{
return *(iter_->second.first);
}
//! \todo Please doc me!
int process() const
{
return iter_->first;
}
//! \todo Please doc me!
const RemoteIndex* operator->() const
{
return iter_->second.first.operator->();
}
//! \todo Please doc me!
bool operator==(const iterator& other)
{
return other.iter_==iter_;
}
//! \todo Please doc me!
bool operator!=(const iterator& other)
{
return other.iter_!=iter_;
......
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