Add documentation to a function.

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

diff --git a/deal.II/include/deal.II/distributed/tria.h b/deal.II/include/deal.II/distributed/tria.h
index 13c877498c3350e739e88a60d09adf93d88743b1..5a8b0d97ff44740730b68c0ffaf8afd1f300da72 100644 (file)
--- a/deal.II/include/deal.II/distributed/tria.h
+++ b/deal.II/include/deal.II/distributed/tria.h
@@ -709,11 +709,16 @@ namespace parallel
                                          */
        MPI_Comm get_communicator () const;
 
-       /**
-        * */
-               const std::vector<unsigned int> &
+                                        /**
+                                         * Returns a permutation vector for the order the coarse
+                                         * cells are handed of to p4est. For example the first
+                                         * element i in this vector denotes that the first cell
+                                         * in hierarchical ordering is the ith deal cell starting
+                                         * from begin(0).
+                                         */
+       const std::vector<unsigned int> &
        get_p4est_tree_to_coarse_cell_permutation() const;
-       
+
                                         /**
                                          * Return the subdomain id of
                                          * those cells that are owned