]> https://gitweb.dealii.org/ - dealii.git/commitdiff
doxygen fixes
authorTimo Heister <timo.heister@gmail.com>
Sun, 17 Jan 2016 19:47:04 +0000 (13:47 -0600)
committerTimo Heister <timo.heister@gmail.com>
Sun, 17 Jan 2016 20:30:10 +0000 (14:30 -0600)
examples/step-4/step-4.cc
include/deal.II/base/array_view.h
include/deal.II/base/polynomials_bdm.h
include/deal.II/distributed/tria.h
include/deal.II/fe/mapping.h
include/deal.II/grid/grid_generator.h
include/deal.II/grid/grid_refinement.h
include/deal.II/lac/la_vector.h
include/deal.II/lac/sparsity_tools.h
source/grid/tria.cc

index 4554a346de650ea913088ba7dea20ac1d018770d..6507fdba9dd1e420cffa558d9bbff8fd03b8ad55 100644 (file)
@@ -179,7 +179,7 @@ double RightHandSide<dim>::value (const Point<dim> &p,
 }
 
 
-// As boundary values, we choose x*x+y*y in 2D, and x*x+y*y+z*z in 3D. This
+// As boundary values, we choose $x^2+y^2$ in 2D, and $x^2+y^2+z^2$ in 3D. This
 // happens to be equal to the square of the vector from the origin to the
 // point at which we would like to evaluate the function, irrespective of the
 // dimension. So that is what we return:
index 6194ad298198020e407b3cfc461887651ef106f2..f6769cf80dfeb34bde3502192cdb24dc4a2fab68 100644 (file)
@@ -254,7 +254,7 @@ make_array_view (const std::vector<ElementType> &vector)
  *   vector that will be part of this view.
  * @param[in] size_of_view
  *
- * @pre <code>starting_index + size_of_view <= vector.size()
+ * @pre <code>starting_index + size_of_view <= vector.size()</code>
  *
  * @relates ArrayView
  */
@@ -289,7 +289,7 @@ make_array_view (std::vector<ElementType> &vector,
  *   vector that will be part of this view.
  * @param[in] size_of_view
  *
- * @pre <code>starting_index + size_of_view <= vector.size()
+ * @pre <code>starting_index + size_of_view <= vector.size()</code>
  *
  * @relates ArrayView
  */
index 9a24aa2eb51debb99ca0745b32f86fceb15bc076..e7fffedbcdcb4b40d439a6d9a76fe9c6bc098777 100644 (file)
@@ -53,7 +53,7 @@ DEAL_II_NAMESPACE_OPEN
  *   Note: the curl of a scalar function is given by $\text{curl}(f(x,y)) =
  *   \begin{pmatrix} f_{y}(x,y) \\ -f_{x}(x,y) \end{pmatrix}$.
  *
- *   <dd> The basis used to construct the $BDM_{1}$ shape functions is
+ *   The basis used to construct the $BDM_{1}$ shape functions is
  *   @f{align*}
  *     \phi_0 = \begin{pmatrix} 1 \\ 0 \end{pmatrix},
  *     \phi_1 = \begin{pmatrix} -\sqrt{3}+2\sqrt{3}x \\ 0 \end{pmatrix},
@@ -65,7 +65,7 @@ DEAL_II_NAMESPACE_OPEN
  *     \phi_7 = \begin{pmatrix} 2xy \\ -y^2 \end{pmatrix}.
  *   @f}
  *
- *   <dd> The dimension of the $BDM_{k}$ space is
+ *   The dimension of the $BDM_{k}$ space is
  * $(k+1)(k+2)+2$, with $k+1$ unknowns per
  * edge and $k(k-1)$ interior unknowns.
  *
@@ -81,13 +81,12 @@ DEAL_II_NAMESPACE_OPEN
  *        \begin{pmatrix}0\\zx^{i+1}y^{k-i}\\0\end{pmatrix})
  *        , p_{k} \in (P_{k})^{3} \}$.
  *
- *   <dd> Note: the 3D description of $BDM_{k}$ is not unique.
- *        See <i>Mixed and Hybrid Finite Element Methods</i> page 122
- *        for an alternative definition.
+ *   Note: the 3D description of $BDM_{k}$ is not unique.  See <i>Mixed and
+ *   Hybrid Finite Element Methods</i> page 122 for an alternative definition.
  *
- *   <dd> The dimension of the $BDM_{k}$ space is
- *        $\dfrac{(k+1)(k+2)(k+3)}{2} + 3(k+1)$, with $\dfrac{(k+1)(k+2)}{2}$
- *        unknowns per face and $\dfrac{(k-1)k(k+1)}{2}$ interior unknowns.
+ *   The dimension of the $BDM_{k}$ space is
+ *   $\dfrac{(k+1)(k+2)(k+3)}{2}+3(k+1)$, with $\dfrac{(k+1)(k+2)}{2}$
+ *   unknowns per face and $\dfrac{(k-1)k(k+1)}{2}$ interior unknowns.
  *
  *</dl>
  *
index 5a09bb51dc9831002fb6b6a29cc4f8f9ed6afe41..adec7a751181d410717d99dd4ac2d69d37206021 100644 (file)
@@ -921,7 +921,7 @@ namespace parallel
        * weights before repartitioning occurs. Called from
        * execute_coarsening_and_refinement() and repartition().
        *
-       * @param return A vector of unsigned integers representing the weight or
+       * @return A vector of unsigned integers representing the weight or
        * computational load of every cell after the refinement/coarsening/
        * repartition cycle. Note that the number of entries does not need to
        * be equal to either n_active_cells or n_locally_owned_active_cells,
index c539743346d582d38c62d7475eab9f21183271b8..8023bd88721470e8cba29494b5f50bb589a7d4c2 100644 (file)
@@ -1098,6 +1098,7 @@ public:
    *
    * where @f[ J^{\dagger} = J(\hat{\mathbf  x})(J(\hat{\mathbf  x})^{T} J(\hat{\mathbf  x}))^{-1}.
    * @f]
+   * </ul>
    *
    * Hessians of spacedim-vector valued differentiable functions are
    * transformed this way (After subtraction of the product of the
index dd254ff4d1e16f4130d0b7aeebe6e7e150a1a381..e1fcd879352a0f9029dabfcde71f310d0b5d00e2 100644 (file)
@@ -978,7 +978,7 @@ namespace GridGenerator
    *   dim==2, then the cells are quadrilaterals that either live in the
    *   plane, or form a surface in a higher-dimensional space. The dimension
    *   of the cells of the surface mesh is consequently dim-1.
-   * @param spacedim The dimension of the space in which both the volume and
+   * @tparam spacedim The dimension of the space in which both the volume and
    *   the surface mesh live.
    *
    * @param[in] volume_mesh A container of cells that define the volume mesh.
index 6a83959125d63525bc521072f1ef7f08c1186f45..a42b5f27b6e73a44b81535d5bac41e76dcf71817 100644 (file)
@@ -192,7 +192,7 @@ namespace GridRefinement
    * above, this function only computes the threshold values and then passes
    * over to refine() and coarsen().
    *
-   * @param[in,out] triangulation The triangulation whose cells this function is
+   * @param[in,out] tria The triangulation whose cells this function is
    * supposed to mark for coarsening and refinement.
    *
    * @param[in] criteria The refinement criterion computed on each mesh cell.
index 3ef5cda12a95c89160cc2987cc357b932184de09..38368ecfccbb5511df9074f14f0a4dd23d64795a 100644 (file)
@@ -47,7 +47,7 @@ namespace LinearAlgebra
    * C++ standard library, this class implements an element of a vector space
    * suitable for numerical computations.
    *
-   * @authod Bruno Turcksin, 2015.
+   * @author Bruno Turcksin, 2015.
    */
   template <typename Number>
   class Vector : public ReadWriteVector<Number>, public VectorSpaceVector<Number>
index 68b3190b01b879b308d25d0217c1fa214164df8e..fc5871bc5caf84796693a83d258ba505760600b9 100644 (file)
@@ -204,10 +204,14 @@ namespace SparsityTools
   /**
    * Similar to the function above, but for BlockDynamicSparsityPattern
    * instead.
+   *
+   * @param[in,out] dsp The locally built sparsity pattern to be modified.
 
    * @param owned_set_per_cpu Typically the value given by
    * DoFHandler::locally_owned_dofs_per_processor.
    *
+   * @param mpi_comm The MPI communicator to use.
+   *
    * @param myrange Typically the locally relevant DoFs.
    */
   void distribute_sparsity_pattern
index 540433f3a606d9631091026285d9d60c2740b7f6..4a0c54c3b33d913a8416e0d2457b8b05b5b8cbda 100644 (file)
@@ -1065,8 +1065,10 @@ namespace internal
      * dim==3. However, their implementation is largly independent of the
      * spacedim template parameter. So we would like to write things like
      *
+     * @code
      * template <int spacedim>
      * void Triangulation<1,spacedim>::create_triangulation (...) {...}
+     * @endcode
      *
      * Unfortunately, C++ doesn't allow this: member functions of class
      * templates have to be either not specialized at all, or fully
@@ -1074,21 +1076,25 @@ namespace internal
      * solution would be to just duplicate the bodies of the functions and
      * have equally implemented functions
      *
+     * @code
      * template <>
      * void Triangulation<1,1>::create_triangulation (...) {...}
      *
      * template <>
      * void Triangulation<1,2>::create_triangulation (...) {...}
+     * @endcode
      *
      * but that is clearly an unsatisfactory solution. Rather, what we do
      * is introduce the current Implementation class in which we can write
      * these functions as member templates over spacedim, i.e. we can have
      *
+     * @code
      * template <int dim_, int spacedim_>
      * template <int spacedim>
      * void Triangulation<dim_,spacedim_>::Implementation::
      *            create_triangulation (...,
      *                                  Triangulation<1,spacedim> &tria ) {...}
+     * @endcode
      *
      * The outer template parameters are here unused, only the inner
      * ones are of real interest.

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.