]> https://gitweb.dealii.org/ - dealii-svn.git/commitdiff
Patch by Felix Gruber: Fix all sorts of misspellings and documentation markup fixes.
authorbangerth <bangerth@0785d39b-7218-0410-832d-ea1e28bc413d>
Thu, 25 Jul 2013 10:53:32 +0000 (10:53 +0000)
committerbangerth <bangerth@0785d39b-7218-0410-832d-ea1e28bc413d>
Thu, 25 Jul 2013 10:53:32 +0000 (10:53 +0000)
git-svn-id: https://svn.dealii.org/trunk@30154 0785d39b-7218-0410-832d-ea1e28bc413d

15 files changed:
deal.II/doc/development/doxygen.html
deal.II/doc/doxygen/headers/global_dof_index.h
deal.II/doc/doxygen/headers/glossary.h
deal.II/doc/doxygen/headers/instantiations.h
deal.II/doc/doxygen/headers/vector_valued.h
deal.II/doc/news/7.0.0-vs-7.1.0.h
deal.II/doc/news/7.2.0-vs-7.3.0.h
deal.II/examples/step-22/doc/intro.dox
deal.II/examples/step-22/doc/results.dox
deal.II/include/deal.II/base/subscriptor.h
deal.II/include/deal.II/base/template_constraints.h
deal.II/include/deal.II/base/utilities.h
deal.II/include/deal.II/fe/mapping.h
deal.II/include/deal.II/lac/slepc_solver.h
deal.II/include/deal.II/lac/sparsity_pattern.h

index 2db340d6a20dfc8d35f4c1828ed4ede4bc4aab95..ff8d4f55d199dc01cd7ef8ad84010a09dcf09e77 100644 (file)
@@ -18,7 +18,7 @@
 
   <p>deal.II has an extensive reference documentation generated
   by <a href="http://www.doxygen.org">Doxygen</a>. One of the many
-  features of Doxygen is, that all class names, function noames and so
+  features of Doxygen is, that all class names, function names and so
   on are cross-linked in the documentation, and a single click
   suffices to jump to the documentation of an object.</p>
 
index a4b55424168cf465353f951935b605ce17535759..51ebce36d7a40e91181a8ea3cfc2f617f38326c4 100644 (file)
@@ -65,6 +65,7 @@
  * can solve now, there is no reason for the number of non-zero entries in a 
  * sparse matrix to go over four billions. Thus, we still use unsigned int
  * for, e.g., row_lengths in the object.
+ * </dd>
  *
- * 
+ * </dl>
  */
index a84c1a6612c4f582d5f39f3b7299e9627a4222db..3bd507b725cf43ef58c2d73bfc4e1777392a0801 100644 (file)
  * to adding elements or setting them.  In some cases, not all processors may
  * be adding elements, for example if a processor does not own any cells when
  * using a very coarse (initial) mesh.  For this reason, compress() takes an
- * argument of type VectorOperation, which can be either ::add, or ::insert.
+ * argument of type VectorOperation, which can be either ::%add, or ::%insert.
  * This argument is required for vectors and matrices starting with the 7.3
  * release.
  *
index 91e95805d0469a08fcf5c6811df533646bb55465..59c2b3424c2aff6af11eba1eff436838cdd5c204 100644 (file)
  * 
  * @subsection Inst2p Provided instances
  *
- * Like with the classes in section Inst1, the instances provided in the
+ * Like with the classes in section @ref Inst1, the instances provided in the
  * library are often listed in the documentation of that class in a form
  * similar to this:
  @verbatim
index 9c24a2f7c5a898b30df0b5a4b55f69737f4eb8b2..2edcd2d5a8b85dfc5698642cd49ba917353164cf 100644 (file)
   \right)_\Omega,
 @f}
  * where $\varepsilon(\mathbf u) = \frac 12 \left([\nabla\mathbf u] +
- * [\nabla\mathbf u]^2\right)$ is the symmetrized gradient.
+ * [\nabla\mathbf u]^T\right)$ is the symmetrized gradient.
  * In the second to last step, we used that the scalar product between
  * an arbitrary tensor $\nabla\mathbf u$ and a symmetric tensor
  * $\frac 12[\partial_i v_j + \partial_j v_i]$ equals the scalar product
index 6d4ef48ce170e8721864f08f05b5c465ef2975f3..5e6decd05c3e6052232a6aed46d83c114426e1ab 100644 (file)
@@ -727,7 +727,7 @@ were not properly mapped. This is now fixed.
 
 <li> New: Restructured the internals of <code>PETScWrappers::Precondition*</code>
 to allow a PETSc PC object to exist without a solver. New: Use
-<code>Precondition*::vmult()</code> to apply the preconditioner once.
+<code>Precondition*::%vmult()</code> to apply the preconditioner once.
 Preconditioners now have a default constructor and an <code>initialize()</code>
 function and are no longer initialized in the solver call,
 but in the constructor or <code>initialize()</code>.
index e40b25cb1998bf667ed88baacc2afb63d100ab5b..52808bccd73f07cc0b25f7c98eddee825f88a54d 100644 (file)
@@ -224,7 +224,7 @@ that takes a std::vector<IndexSet> (same interface as in Trilinos).
 <br>
 (Timo Heister, 2013/02/19)
 
-<li> New: PETScWrappers::*Matrix::add(other, factor) to
+<li> New: PETScWrappers::*Matrix::%add(other, factor) to
 add a scaled other matrix to the current matrix.
 <br>
 (Jose Javier Munoz Criollo, 2013/02/19)
index 73a5674dace1b2f7ec6eb4550de8a3a953b7013c..b57dbed1baf0913595264b39a78eeb26ddaf6bc6 100644 (file)
@@ -566,7 +566,7 @@ struct InnerPreconditioner<3>
 @endcode
 
 From hereon, we can refer to the type <code>typename
-InnerPreconditioner@<dim@>::type</code> and automatically get the correct
+InnerPreconditioner@<dim@>::%type</code> and automatically get the correct
 preconditioner class. Because of the similarity of the interfaces of the two
 classes, we will be able to use them interchangeably using the same syntax in
 all places.
index 3524d69293fcc2d9c33e847ab17e483545485f69..526329912753e94d9eeef47eb743585bcdf47990 100644 (file)
@@ -119,7 +119,7 @@ This plot uses the capability of VTK-based visualization programs (in
 this case of VisIt) to show vector data; this is the result of us
 declaring the velocity components of the finite element in use to be a
 set of vector components, rather than independent scalar components in
-the <code>StokesProblem@<dim@>::output_results</code> function of this
+the <code>StokesProblem@<dim@>::%output_results</code> function of this
 tutorial program.
 
 
index a6372e016eb7b7cd71a886465a61d0f7f41068be..44d425865c4bf61a6f85fff08b5a2a867efe580c 100644 (file)
@@ -49,7 +49,7 @@ DEAL_II_NAMESPACE_OPEN
  * same. The handling in SmartPointer will take care of this.
  *
  * @note Due to a problem with <tt>volatile</tt> declarations, this
- * additional feature is switched of if multithreading is used.
+ * additional feature is switched off if multithreading is used.
  *
  * @ingroup memory
  * @author Guido Kanschat, 1998 - 2005
index f77a552c71b2d1c7d3232d32138c7d0daf38c3df..b123fbe109e9ed17fd3925d9bac2373150130da2 100644 (file)
@@ -209,7 +209,7 @@ namespace internal
    *   template <>
    *   void X<dim>::f<0> () { ...operate on the vertices of a cell... }
    *
-   *   template <int dim, int subdim> void f(X<dim> &x) {
+   *   template <int dim, int subdim> void g(X<dim> &x) {
    *     x.f<subdim> ();
    *   }
    * @endcode
@@ -238,7 +238,7 @@ namespace internal
    *   template <int dim>
    *   void X<dim>::f (int2type<1>) { ...operate on the lines of a cell... }
    *
-   *   template <int dim, int subdim> void f(X<dim> &x) {
+   *   template <int dim, int subdim> void g(X<dim> &x) {
    *     x.f (int2type<subdim>());
    *   }
    * @endcode
index df17f8f976dfae82f123ee7b1495c1cc501d74b5..db5d8b435adf4cb86456ddb204f4eba476575368 100644 (file)
@@ -226,7 +226,7 @@ namespace Utilities
    * templates.
    *
    * Use this class as in
-   * <code>fixed_int_power@<5,2@>::value</code>
+   * <code>fixed_int_power@<5,2@>::%value</code>
    * to compute 5<sup>2</sup>.
    */
   template <int a, int N>
index f93a0cdf05650f392a7ff106881d7b7a06be4713..30ae94374310085f790da616278ce945492255c1 100644 (file)
@@ -52,6 +52,8 @@ template <int dim, int spacedim> class FESubfaceValues;
  * the transform() functions of
  * inheriting classes in order to
  * work.
+ *
+ * @ingroup mapping
  */
 enum MappingType
 {
index b5135d7403593c1c317807cb2c69932c51c9cd16..509297a5742a2c54add04acacfa850c47d7c504e 100644 (file)
@@ -297,7 +297,7 @@ namespace SLEPcWrappers
     EPS *get_eps ();
 
     /**
-     * Solve the linear system for </code>n_eigenpairs</code>
+     * Solve the linear system for <code>n_eigenpairs</code>
      * eigenstates. Parameter <code>n_converged</code> contains the
      * actual number of eigenstates that have .  converged; this can
      * be both fewer or more than n_eigenpairs, depending on the
index b327e5b9ab8fa70b52b51b80eb7ae9700153219f..ada6bbf528afb5021496fed09a18f8066f155d35 100644 (file)
@@ -1147,7 +1147,7 @@ public:
   /**
    * Write the data of this object en bloc to a file. This is done in a binary
    * mode, so the output is neither readable by humans nor (probably) by other
-   * computers using a different operating system of number format.
+   * computers using a different operating system or number format.
    *
    * The purpose of this function is that you can swap out matrices and
    * sparsity pattern if you are short of memory, want to communicate between

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.