From 1cb1031272c088289622af13bc5041d8a2b407bf Mon Sep 17 00:00:00 2001 From: David Wells Date: Sat, 4 Jul 2015 08:27:51 -0400 Subject: [PATCH] Fix comments on a code sample. 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 | 37 +++++++++++--------- 1 file changed, 20 insertions(+), 17 deletions(-) diff --git a/include/deal.II/numerics/fe_field_function.h b/include/deal.II/numerics/fe_field_function.h index 43765678d7..db6bc6fdd2 100644 --- a/include/deal.II/numerics/fe_field_function.h +++ b/include/deal.II/numerics/fe_field_function.h @@ -68,32 +68,35 @@ namespace Functions * * An example of how to use this function is the following: * - * \code + * @code * - * // Generate two triangulations Triangulation tria_1; + * // Generate two triangulations + * Triangulation tria_1; * Triangulation 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 dh1(tria_1); Vector solution_1; + * // Associate a dof handler and a solution to the first triangulation + * DoFHandler dh1 (tria_1); + * Vector solution_1; * - * // Do the same with the second DoFHandler dh2; Vector - * solution_2; + * // Do the same with the second + * DoFHandler dh2 (tria_2); + * Vector 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 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 fe_function_1 (dh_1, solution_1); + * VectorTools::project (dh_2, constraints_2, quad, fe_function_1, solution_2); * - * // Or interpolate it... Vector solution_3; - * VectorTools::interpolate(dh_2, fe_function_1, solution_3); + * // Or interpolate it... + * Vector 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. -- 2.39.5