From: Jean-Paul Pelteret <jppelteret@gmail.com>
Date: Sat, 23 Mar 2019 15:28:24 +0000 (+0100)
Subject: Improve example in new mesh_loop function
X-Git-Tag: v9.1.0-rc1~259^2~1
X-Git-Url: https://gitweb.dealii.org/cgi-bin/gitweb.cgi?a=commitdiff_plain;h=704fb9c003aa49144e1f601620c6f9d22f5f1b3c;p=dealii.git

Improve example in new mesh_loop function
---

diff --git a/include/deal.II/meshworker/mesh_loop.h b/include/deal.II/meshworker/mesh_loop.h
index 8a76d18bc1..d1244d3950 100644
--- a/include/deal.II/meshworker/mesh_loop.h
+++ b/include/deal.II/meshworker/mesh_loop.h
@@ -417,29 +417,37 @@ namespace MeshWorker
    *
    * An example usage of the function is given by
    * @code
+   *
+   * struct ScratchData;
+   * struct CopyData;
+   *
    * template <int dim, int spacedim>
-   * class TestClass
+   * class MyClass
    * {
    * public:
    *   void
    *   cell_worker(const CellIteratorType &cell, ScratchData &, CopyData &);
    *
+   *   void
+   *   copier(const CopyData &);
+   *
    *   ...
    * };
    *
-   *   ...
-   *   TestClass<dim, spacedim> test_class;
-   *   ScratchData              scratch;
-   *   CopyData                 copy;
+   * ...
+   *
+   * MyClass<dim, spacedim> my_class;
+   * SratchData             scratch;
+   * CopyData               copy;
    *
-   *   mesh_loop(tria.begin_active(),
-   *             tria.end(),
-   *             test_class,
-   *             &TestClass<dim, spacedim>::cell_worker,
-   *             &TestClass<dim, spacedim>::copier,
-   *             scratch,
-   *             copy,
-   *             assemble_own_cells);
+   * mesh_loop(tria.begin_active(),
+   *           tria.end(),
+   *           my_class,
+   *           &MyClass<dim, spacedim>::cell_worker,
+   *           &MyClass<dim, spacedim>::copier,
+   *           scratch,
+   *           copy,
+   *           assemble_own_cells);
    * @endcode
    *
    * @ingroup MeshWorker