Document global functions as they are now printed in the docs by kdoc2.

git-svn-id: https://svn.dealii.org/trunk@3096 0785d39b-7218-0410-832d-ea1e28bc413d

diff --git a/deal.II/deal.II/include/grid/tria_iterator.h b/deal.II/deal.II/include/grid/tria_iterator.h
index 73435e7a6847e00b35ad5d6d584cf130c7362a05..e7e5effb8096495ad7f0ffdaeca425e009a3bf75 100644 (file)
--- a/deal.II/deal.II/include/grid/tria_iterator.h
+++ b/deal.II/deal.II/include/grid/tria_iterator.h
@@ -997,6 +997,14 @@ TriaActiveIterator<dim,Accessor>::TriaActiveIterator (const TriaRawIterator<dim,
 
 
 
+/**
+ * Print the address to which this iterator points to @p{out}. The
+ * address is given by the pair @p{(level,index)}, where @p{index} is
+ * an index relative to the level in which the object is that is
+ * pointed to.
+ *
+ * @author Wolfgang Bangerth, 1998
+ */
 template <int dim, typename Accessor>
 inline
 ostream & operator << (ostream &out, const TriaRawIterator<dim,Accessor> &i)
@@ -1007,6 +1015,14 @@ ostream & operator << (ostream &out, const TriaRawIterator<dim,Accessor> &i)
 
 
 
+/**
+ * Print the address to which this iterator points to @p{out}. The
+ * address is given by the pair @p{(level,index)}, where @p{index} is
+ * an index relative to the level in which the object is that is
+ * pointed to.
+ *
+ * @author Wolfgang Bangerth, 1998
+ */
 template <int dim, typename Accessor>
 inline
 ostream & operator << (ostream &out, const TriaIterator<dim,Accessor> &i)
@@ -1017,6 +1033,14 @@ ostream & operator << (ostream &out, const TriaIterator<dim,Accessor> &i)
 
 
 
+/**
+ * Print the address to which this iterator points to @p{out}. The
+ * address is given by the pair @p{(level,index)}, where @p{index} is
+ * an index relative to the level in which the object is that is
+ * pointed to.
+ *
+ * @author Wolfgang Bangerth, 1998
+ */
 template <int dim, typename Accessor>
 inline
 ostream & operator << (ostream &out, const TriaActiveIterator<dim,Accessor> &i)