Fix documentation.

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

diff --git a/deal.II/deal.II/include/grid/grid_generator.h b/deal.II/deal.II/include/grid/grid_generator.h
index bd07bcf03e6744671e6f8f913b4580a659bff273..c45842f9afd81c401112a6e2e948f37066d0297b 100644 (file)
--- a/deal.II/deal.II/include/grid/grid_generator.h
+++ b/deal.II/deal.II/include/grid/grid_generator.h
@@ -436,9 +436,17 @@ class GridGenerator
                                      /**
                                      * Initialize the given
                                      * Triangulation with a hypercube
-                                     * with a slit. The slit goes
-                                     * from <tt>(x=0,y=-1)</tt> to
-                                     * <tt>(0,0)</tt> in 2d.
+                                     * with a slit. In each
+                                     * coordinate direction, the
+                                     * hypercube extends from @p left
+                                     * to @p right.
+                                     *
+                                     * In 2d, the split goes in
+                                     * vertical direction from
+                                     * <tt>x=(left+right)/2,
+                                     * y=left</tt> to the center of
+                                     * the square at
+                                     * <tt>x=y=(left+right)/2</tt>.
                                      *
                                      * The triangulation needs to be
                                      * void upon calling this
@@ -448,7 +456,7 @@ class GridGenerator
                                      * exist for triangulations of
                                      * all space dimensions, but
                                      * throws an error if called in
-                                     * 1d. It is also not presently
+                                     * 1d. It is also presently not
                                      * implemented in 3d.
                                      */
     static void hyper_cube_slit (Triangulation<1> &tria,