Add something to the documentation.

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

diff --git a/deal.II/include/deal.II/grid/grid_generator.h b/deal.II/include/deal.II/grid/grid_generator.h
index efdd65a8ae0f30dca5916286948c7724b3366659..27b5dfee0bc8267f4fd0617be17b54a9b6afc6a7 100644 (file)
--- a/deal.II/include/deal.II/grid/grid_generator.h
+++ b/deal.II/include/deal.II/grid/grid_generator.h
@@ -335,7 +335,7 @@ namespace GridGenerator
                         const double        radius = 1.);
 
   /**
-   * Create a cylinder around the x-axis.  The cylinder extends from
+   * Create a cylinder around the $x$-axis.  The cylinder extends from
    * <tt>x=-half_length</tt> to <tt>x=+half_length</tt> and its projection
    * into the @p yz-plane is a circle of radius @p radius.
    *
@@ -347,6 +347,11 @@ namespace GridGenerator
    * hull of the cylinder, 1 for the left hand face and 2 for the right hand
    * face.
    *
+   * If you want the cylinder to revolve around a different axis than the
+   * $x$-axis, then simply rotate the mesh generated by this function using
+   * the GridTools::transform() function using a rotation operator as
+   * argument.
+   *
    * @note The triangulation needs to be void upon calling this function.
    */
   template <int dim>