Describe input and output parameters for flatten_triangulation()

diff --git a/doc/news/changes/minor/20190708LuelEmishaw b/doc/news/changes/minor/20190708LuelEmishaw
new file mode 100644 (file)
index 0000000..dae4662
--- /dev/null
+++ b/doc/news/changes/minor/20190708LuelEmishaw
@@ -0,0 +1,5 @@
+Improved: flatten_triangulation() description by adding parameter inputs.
+
+Luel Emishaw (2019/09/08)
+
+

diff --git a/include/deal.II/grid/grid_generator.h b/include/deal.II/grid/grid_generator.h
index 1c51c127dc375bc05136cb8d8a6f6da4e3116152..dd2fb3d62759b5d8bf923aa86c21224de69dd8a8 100644 (file)
--- a/include/deal.II/grid/grid_generator.h
+++ b/include/deal.II/grid/grid_generator.h
@@ -1535,6 +1535,10 @@ namespace GridGenerator
    * parallel::distributed::Triangulation, as well as when the input
    * Triangulation contains hanging nodes.
    *
+   * @param[in] in_tria The base input for a new flat triangulation.
+   * @param[out] out_tria The desired flattened triangulation constructed from
+   * the in_tria.
+   *
    * @note Since @p input and @p output have different spatial dimensions no
    * manifold objects are copied by this function: you must attach new
    * manifold objects to @p out_tria.