From dfcfb5bc5c9226bec63307727ee92ba944b825a3 Mon Sep 17 00:00:00 2001 From: bangerth Date: Thu, 25 Jul 2013 10:53:32 +0000 Subject: [PATCH] Patch by Felix Gruber: Fix all sorts of misspellings and documentation markup fixes. git-svn-id: https://svn.dealii.org/trunk@30154 0785d39b-7218-0410-832d-ea1e28bc413d --- deal.II/doc/development/doxygen.html | 2 +- deal.II/doc/doxygen/headers/global_dof_index.h | 3 ++- deal.II/doc/doxygen/headers/glossary.h | 2 +- deal.II/doc/doxygen/headers/instantiations.h | 2 +- deal.II/doc/doxygen/headers/vector_valued.h | 2 +- deal.II/doc/news/7.0.0-vs-7.1.0.h | 2 +- deal.II/doc/news/7.2.0-vs-7.3.0.h | 2 +- deal.II/examples/step-22/doc/intro.dox | 2 +- deal.II/examples/step-22/doc/results.dox | 2 +- deal.II/include/deal.II/base/subscriptor.h | 2 +- deal.II/include/deal.II/base/template_constraints.h | 4 ++-- deal.II/include/deal.II/base/utilities.h | 2 +- deal.II/include/deal.II/fe/mapping.h | 2 ++ deal.II/include/deal.II/lac/slepc_solver.h | 2 +- deal.II/include/deal.II/lac/sparsity_pattern.h | 2 +- 15 files changed, 18 insertions(+), 15 deletions(-) diff --git a/deal.II/doc/development/doxygen.html b/deal.II/doc/development/doxygen.html index 2db340d6a2..ff8d4f55d1 100644 --- a/deal.II/doc/development/doxygen.html +++ b/deal.II/doc/development/doxygen.html @@ -18,7 +18,7 @@

deal.II has an extensive reference documentation generated by Doxygen. 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.

diff --git a/deal.II/doc/doxygen/headers/global_dof_index.h b/deal.II/doc/doxygen/headers/global_dof_index.h index a4b5542416..51ebce36d7 100644 --- a/deal.II/doc/doxygen/headers/global_dof_index.h +++ b/deal.II/doc/doxygen/headers/global_dof_index.h @@ -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. + * * - * + * */ diff --git a/deal.II/doc/doxygen/headers/glossary.h b/deal.II/doc/doxygen/headers/glossary.h index a84c1a6612..3bd507b725 100644 --- a/deal.II/doc/doxygen/headers/glossary.h +++ b/deal.II/doc/doxygen/headers/glossary.h @@ -544,7 +544,7 @@ * 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. * diff --git a/deal.II/doc/doxygen/headers/instantiations.h b/deal.II/doc/doxygen/headers/instantiations.h index 91e95805d0..59c2b3424c 100644 --- a/deal.II/doc/doxygen/headers/instantiations.h +++ b/deal.II/doc/doxygen/headers/instantiations.h @@ -111,7 +111,7 @@ * * @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 diff --git a/deal.II/doc/doxygen/headers/vector_valued.h b/deal.II/doc/doxygen/headers/vector_valued.h index 9c24a2f7c5..2edcd2d5a8 100644 --- a/deal.II/doc/doxygen/headers/vector_valued.h +++ b/deal.II/doc/doxygen/headers/vector_valued.h @@ -684,7 +684,7 @@ \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 diff --git a/deal.II/doc/news/7.0.0-vs-7.1.0.h b/deal.II/doc/news/7.0.0-vs-7.1.0.h index 6d4ef48ce1..5e6decd05c 100644 --- a/deal.II/doc/news/7.0.0-vs-7.1.0.h +++ b/deal.II/doc/news/7.0.0-vs-7.1.0.h @@ -727,7 +727,7 @@ were not properly mapped. This is now fixed.
  • New: Restructured the internals of PETScWrappers::Precondition* to allow a PETSc PC object to exist without a solver. New: Use -Precondition*::vmult() to apply the preconditioner once. +Precondition*::%vmult() to apply the preconditioner once. Preconditioners now have a default constructor and an initialize() function and are no longer initialized in the solver call, but in the constructor or initialize(). diff --git a/deal.II/doc/news/7.2.0-vs-7.3.0.h b/deal.II/doc/news/7.2.0-vs-7.3.0.h index e40b25cb19..52808bccd7 100644 --- a/deal.II/doc/news/7.2.0-vs-7.3.0.h +++ b/deal.II/doc/news/7.2.0-vs-7.3.0.h @@ -224,7 +224,7 @@ that takes a std::vector (same interface as in Trilinos).
    (Timo Heister, 2013/02/19) -
  • New: PETScWrappers::*Matrix::add(other, factor) to +
  • New: PETScWrappers::*Matrix::%add(other, factor) to add a scaled other matrix to the current matrix.
    (Jose Javier Munoz Criollo, 2013/02/19) diff --git a/deal.II/examples/step-22/doc/intro.dox b/deal.II/examples/step-22/doc/intro.dox index 73a5674dac..b57dbed1ba 100644 --- a/deal.II/examples/step-22/doc/intro.dox +++ b/deal.II/examples/step-22/doc/intro.dox @@ -566,7 +566,7 @@ struct InnerPreconditioner<3> @endcode From hereon, we can refer to the type typename -InnerPreconditioner@::type and automatically get the correct +InnerPreconditioner@::%type 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. diff --git a/deal.II/examples/step-22/doc/results.dox b/deal.II/examples/step-22/doc/results.dox index 3524d69293..5263299127 100644 --- a/deal.II/examples/step-22/doc/results.dox +++ b/deal.II/examples/step-22/doc/results.dox @@ -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 StokesProblem@::output_results function of this +the StokesProblem@::%output_results function of this tutorial program. diff --git a/deal.II/include/deal.II/base/subscriptor.h b/deal.II/include/deal.II/base/subscriptor.h index a6372e016e..44d425865c 100644 --- a/deal.II/include/deal.II/base/subscriptor.h +++ b/deal.II/include/deal.II/base/subscriptor.h @@ -49,7 +49,7 @@ DEAL_II_NAMESPACE_OPEN * same. The handling in SmartPointer will take care of this. * * @note Due to a problem with volatile 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 diff --git a/deal.II/include/deal.II/base/template_constraints.h b/deal.II/include/deal.II/base/template_constraints.h index f77a552c71..b123fbe109 100644 --- a/deal.II/include/deal.II/base/template_constraints.h +++ b/deal.II/include/deal.II/base/template_constraints.h @@ -209,7 +209,7 @@ namespace internal * template <> * void X::f<0> () { ...operate on the vertices of a cell... } * - * template void f(X &x) { + * template void g(X &x) { * x.f (); * } * @endcode @@ -238,7 +238,7 @@ namespace internal * template * void X::f (int2type<1>) { ...operate on the lines of a cell... } * - * template void f(X &x) { + * template void g(X &x) { * x.f (int2type()); * } * @endcode diff --git a/deal.II/include/deal.II/base/utilities.h b/deal.II/include/deal.II/base/utilities.h index df17f8f976..db5d8b435a 100644 --- a/deal.II/include/deal.II/base/utilities.h +++ b/deal.II/include/deal.II/base/utilities.h @@ -226,7 +226,7 @@ namespace Utilities * templates. * * Use this class as in - * fixed_int_power@<5,2@>::value + * fixed_int_power@<5,2@>::%value * to compute 52. */ template diff --git a/deal.II/include/deal.II/fe/mapping.h b/deal.II/include/deal.II/fe/mapping.h index f93a0cdf05..30ae943743 100644 --- a/deal.II/include/deal.II/fe/mapping.h +++ b/deal.II/include/deal.II/fe/mapping.h @@ -52,6 +52,8 @@ template class FESubfaceValues; * the transform() functions of * inheriting classes in order to * work. + * + * @ingroup mapping */ enum MappingType { diff --git a/deal.II/include/deal.II/lac/slepc_solver.h b/deal.II/include/deal.II/lac/slepc_solver.h index b5135d7403..509297a574 100644 --- a/deal.II/include/deal.II/lac/slepc_solver.h +++ b/deal.II/include/deal.II/lac/slepc_solver.h @@ -297,7 +297,7 @@ namespace SLEPcWrappers EPS *get_eps (); /** - * Solve the linear system for n_eigenpairs + * Solve the linear system for n_eigenpairs * eigenstates. Parameter n_converged contains the * actual number of eigenstates that have . converged; this can * be both fewer or more than n_eigenpairs, depending on the diff --git a/deal.II/include/deal.II/lac/sparsity_pattern.h b/deal.II/include/deal.II/lac/sparsity_pattern.h index b327e5b9ab..ada6bbf528 100644 --- a/deal.II/include/deal.II/lac/sparsity_pattern.h +++ b/deal.II/include/deal.II/lac/sparsity_pattern.h @@ -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 -- 2.39.5