improved documentation for grid generator

diff --git a/doc/news/changes/minor/20190807MJayadharan b/doc/news/changes/minor/20190807MJayadharan
new file mode 100644 (file)
index 0000000..eaa50d6
--- /dev/null
+++ b/doc/news/changes/minor/20190807MJayadharan
@@ -0,0 +1,3 @@
+Changed: Improved the documentation about GridGenerator::subdivided_hyper_cube().
+<br>
+(Manu Jayadharan, 2019/08/07)

diff --git a/include/deal.II/grid/grid_generator.h b/include/deal.II/grid/grid_generator.h
index f1b0434d1ba6d8cefc6237db042bcf8d120ceaa2..32f1de5aa3e7b1a801559ac60f33a0933f4178cc 100644 (file)
--- a/include/deal.II/grid/grid_generator.h
+++ b/include/deal.II/grid/grid_generator.h
@@ -135,6 +135,17 @@ namespace GridGenerator
    * <tt>Triangulation@<2,3@></tt> will be a square in the xy plane with z=0.
    *
    * @note The triangulation passed as argument needs to be empty when calling this function.
+   *
+   * @param tria The Triangulation to create. It needs to be empty upon
+   * calling this function.
+   *
+   * @param repetitions A vector of @p dim positive values denoting the number
+   * of cells to generate in that direction. For example, first component of the vector specifies the number of cells
+   * in the x-direction, second component specifies that for the y-direction for dim=2.
+   *
+   * @param left Lower bound for the interval used to create the hyper cube.
+   *
+   * @param right Upper bound for the interval used to create the hyper cube.
    */
   template <int dim, int spacedim>
   void