]> https://gitweb.dealii.org/ - dealii.git/commitdiff
Fix comments on a code sample. 1112/head
authorDavid Wells <drwells@vt.edu>
Sat, 4 Jul 2015 12:27:51 +0000 (08:27 -0400)
committerDavid Wells <drwells@vt.edu>
Sat, 11 Jul 2015 12:01:33 +0000 (08:01 -0400)
The comments and code were intercalated in an incorrect manner, where
some comments were uncommented and some code was (incorrectly)
commented. I also fixed a small error in the example code (the dof
handler was not associated a triangulation).

include/deal.II/numerics/fe_field_function.h

index 43765678d787179e1fe847946e617032304bac25..db6bc6fdd2953b02bfb4df5c31b319da8c7bf309 100644 (file)
@@ -68,32 +68,35 @@ namespace Functions
    *
    * An example of how to use this function is the following:
    *
-   * \code
+   * @code
    *
-   * // Generate two triangulations Triangulation<dim> tria_1;
+   * // Generate two triangulations
+   * Triangulation<dim> tria_1;
    * Triangulation<dim> tria_2;
    *
-   * // Read the triangulations from files, or build them up, or get // them
-   * from some place...  Assume that tria_2 is *entirely* // included in
-   * tria_1 ...
+   * // Read the triangulations from files, or build them up, or get them
+   * // from some place. Assume that tria_2 is *entirely* included in tria_1.
    *
-   * // Associate a dofhandler and a solution to the first // triangulation
-   * DoFHandler<dim> dh1(tria_1); Vector<double> solution_1;
+   * // Associate a dof handler and a solution to the first triangulation
+   * DoFHandler<dim> dh1 (tria_1);
+   * Vector<double> solution_1;
    *
-   * // Do the same with the second DoFHandler<dim> dh2; Vector<double>
-   * solution_2;
+   * // Do the same with the second
+   * DoFHandler<dim> dh2 (tria_2);
+   * Vector<double> solution_2;
    *
-   * // Setup the system, assemble matrices, solve problems and get the //
-   * nobel prize on the first domain... ...
+   * // Setup the system, assemble matrices, solve problems and get the
+   * // nobel prize on the first domain...
    *
-   * // Now project it to the second domain FEFieldFunction<dim> fe_function_1
-   * (dh_1, solution_1); VectorTools::project(dh_2, constraints_2, quad,
-   * fe_function_1, solution_2);
+   * // Now project it to the second domain
+   * FEFieldFunction<dim> fe_function_1 (dh_1, solution_1);
+   * VectorTools::project (dh_2, constraints_2, quad, fe_function_1, solution_2);
    *
-   * // Or interpolate it... Vector<double> solution_3;
-   * VectorTools::interpolate(dh_2, fe_function_1, solution_3);
+   * // Or interpolate it...
+   * Vector<double> solution_3;
+   * VectorTools::interpolate (dh_2, fe_function_1, solution_3);
    *
-   * \endcode
+   * @endcode
    *
    * The snippet of code above will work assuming that the second
    * triangulation is entirely included in the first one.

In the beginning the Universe was created. This has made a lot of people very angry and has been widely regarded as a bad move.

Douglas Adams


Typeset in Trocchi and Trocchi Bold Sans Serif.