]> https://gitweb.dealii.org/ - dealii.git/commitdiff
Fix some minor doxygen issues in step-32. 1105/head
authorDavid Wells <drwells@vt.edu>
Fri, 10 Jul 2015 14:19:19 +0000 (10:19 -0400)
committerDavid Wells <drwells@vt.edu>
Fri, 10 Jul 2015 14:19:19 +0000 (10:19 -0400)
Doxygen did not pick up the quoted text next to a @ref correctly, so I
reworded the paragraph to not need the quoted text.

examples/step-32/step-32.cc

index 929600dc9e19bbd930f2ab5761be386e9753f767..c83ff0bda9209bb167217fabfdfedd219fb8e3a3 100644 (file)
@@ -327,13 +327,12 @@ namespace Step32
   // distinguish between <code>struct</code>s and <code>class</code>es).
   //
   // Regarding the Scratch objects, each struct is equipped with a constructor
-  // that creates an FEValues object for a @ref FiniteElement "finite
-  // element", a @ref Quadrature "quadrature formula", the @ref Mapping
-  // "mapping" that describes the interpolation of curved boundaries, and some
-  // @ref UpdateFlags "update flags".  Moreover, we manually implement a copy
-  // constructor (since the FEValues class is not copyable by itself), and
-  // provide some additional vector fields that are used to hold intermediate
-  // data during the computation of local contributions.
+  // that creates an @ref FEValues object using the @ref FiniteElement,
+  // Quadrature, @ref Mapping (which describes the interpolation of curved
+  // boundaries), and @ref UpdateFlags instances. Moreover, we manually
+  // implement a copy constructor (since the FEValues class is not copyable by
+  // itself), and provide some additional vector fields that are used to hold
+  // intermediate data during the computation of local contributions.
   //
   // Let us start with the scratch arrays and, specifically, the one used for
   // assembly of the Stokes preconditioner:

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.