]> https://gitweb.dealii.org/ - dealii.git/commitdiff
doxygen comments: @ref fixes 13849/head
authorTimo Heister <timo.heister@gmail.com>
Sun, 29 May 2022 19:11:26 +0000 (15:11 -0400)
committerTimo Heister <timo.heister@gmail.com>
Sun, 29 May 2022 19:11:26 +0000 (15:11 -0400)
A few more @ref fixes missed in #13836

include/deal.II/distributed/shared_tria.h
include/deal.II/fe/fe_poly_tensor.h
include/deal.II/fe/fe_raviart_thomas.h
include/deal.II/grid/grid_reordering.h
include/deal.II/particles/particle.h
include/deal.II/particles/particle_accessor.h

index 9b13f8e0c977ada805616149b4da87bd08067268..102c07ac6546507db8e109aa6ffa58595395435e 100644 (file)
@@ -500,7 +500,8 @@ namespace internal
        *
        * This class has effect only if artificial cells are allowed. Without
        * artificial cells, the current subdomain IDs already correspond to the
-       * true subdomain IDs. See the @ref GlossArtificialCell "glossary"
+       * true subdomain IDs. See the
+       * @ref GlossArtificialCell "glossary"
        * for more information about artificial cells.
        */
       template <int dim, int spacedim = dim>
index 2af01f34ad474c62cf7f591c7ef07e5f08917b2a..1918aaa4b163a7aaab7a53e64e2d5ab4ef5384cd 100644 (file)
@@ -252,8 +252,8 @@ protected:
    * The constructor of this class fills this table with 'false' values, i.e.,
    * no sign change at all. Derived finite element classes have to
    * fill this Table with the correct values, see the documentation in
-   * GeometryInfo<dim> and
-   * this @ref GlossFaceOrientation "glossary entry on face orientation".
+   * GeometryInfo<dim> and this
+   * @ref GlossFaceOrientation "glossary entry on face orientation".
    *
    * The table must be filled in finite element classes derived
    * from FE_PolyTensor in a meaningful way since the permutation
index 98ebdc76dac2431c51631fe173b3a00f4da954ed..11ce2ad37f58ac656fc2c2b54b8cfcf0b51fbef0 100644 (file)
@@ -223,7 +223,8 @@ private:
    * flipped (rotated by +180 degrees) or rotated (rotated by +90 degrees)
    * faces. These are given in the form three flags (face_orientation,
    * face_flip, face_rotation), see the documentation in GeometryInfo<dim> and
-   * this @ref GlossFaceOrientation "glossary entry on face orientation".
+   * this
+   * @ref GlossFaceOrientation "glossary entry on face orientation".
    *
    * <h3>Example: Raviart-Thomas Elements of order 2 (tensor polynomial
    * degree 3)</h3>
index 937c465a243b65970d2d1bf55889747054172488..9d33c5c81f76f0185801b958f46ab71e07a27fb5 100644 (file)
@@ -27,7 +27,8 @@ DEAL_II_NAMESPACE_OPEN
 
 /**
  * A class implementing various grid reordering algorithms. For more information
- * see the @ref reordering "reordering module".
+ * see the
+ * @ref reordering "reordering module".
  *
  * @deprecated Use GridTools::invert_all_negative_measure_cells() or
  * GridTools::consistently_order_cells() instead of the functions provided by
index 1fb0ac9484a854dd118e4b1d0b5ef53f5074f261..e4580047f12e60b8574c9a5e38b77f0603466028 100644 (file)
@@ -229,8 +229,11 @@ namespace Particles
      *   on both the locally owned cells, as well as on ghost cells. The
      *   particles on the latter are *copies* of particles owned on other
      *   processors, and should therefore be treated in the same way as
-     *   ghost entries in @ref GlossGhostedVector "vectors with ghost elements"
-     *   or @ref GlossGhostCell "ghost cells": In both cases, one should
+     *   ghost entries in
+     *   @ref GlossGhostedVector "vectors with ghost elements"
+     *   or
+     *   @ref GlossGhostCell "ghost cells":
+     *   In both cases, one should
      *   treat the ghost elements or cells as `const` objects that shouldn't
      *   be modified even if the objects allow for calls that modify
      *   properties. Rather, properties should only be modified on processors
@@ -257,8 +260,11 @@ namespace Particles
      *   on both the locally owned cells, as well as on ghost cells. The
      *   particles on the latter are *copies* of particles owned on other
      *   processors, and should therefore be treated in the same way as
-     *   ghost entries in @ref GlossGhostedVector "vectors with ghost elements"
-     *   or @ref GlossGhostCell "ghost cells": In both cases, one should
+     *   ghost entries in
+     *   @ref GlossGhostedVector "vectors with ghost elements"
+     *   or
+     *   @ref GlossGhostCell "ghost cells":
+     *   In both cases, one should
      *   treat the ghost elements or cells as `const` objects that shouldn't
      *   be modified even if the objects allow for calls that modify
      *   properties. Rather, properties should only be modified on processors
@@ -302,8 +308,11 @@ namespace Particles
      *   on both the locally owned cells, as well as on ghost cells. The
      *   particles on the latter are *copies* of particles owned on other
      *   processors, and should therefore be treated in the same way as
-     *   ghost entries in @ref GlossGhostedVector "vectors with ghost elements"
-     *   or @ref GlossGhostCell "ghost cells": In both cases, one should
+     *   ghost entries in
+     *   @ref GlossGhostedVector "vectors with ghost elements"
+     *   or
+     *   @ref GlossGhostCell "ghost cells":
+     *   In both cases, one should
      *   treat the ghost elements or cells as `const` objects that shouldn't
      *   be modified even if the objects allow for calls that modify
      *   properties. Rather, properties should only be modified on processors
@@ -344,8 +353,11 @@ namespace Particles
      *   on both the locally owned cells, as well as on ghost cells. The
      *   particles on the latter are *copies* of particles owned on other
      *   processors, and should therefore be treated in the same way as
-     *   ghost entries in @ref GlossGhostedVector "vectors with ghost elements"
-     *   or @ref GlossGhostCell "ghost cells": In both cases, one should
+     *   ghost entries in
+     *   @ref GlossGhostedVector "vectors with ghost elements"
+     *   or
+     *   @ref GlossGhostCell "ghost cells":
+     *   In both cases, one should
      *   treat the ghost elements or cells as `const` objects that shouldn't
      *   be modified even if the objects allow for calls that modify
      *   properties. Rather, properties should only be modified on processors
index 03ee1f315dc25946984334fd8beb229f1772832b..c5d15ee20af7c46b7ad4a7691ee52887a4cc6fd1 100644 (file)
@@ -135,8 +135,11 @@ namespace Particles
      *   on both the locally owned cells, as well as on ghost cells. The
      *   particles on the latter are *copies* of particles owned on other
      *   processors, and should therefore be treated in the same way as
-     *   ghost entries in @ref GlossGhostedVector "vectors with ghost elements"
-     *   or @ref GlossGhostCell "ghost cells": In both cases, one should
+     *   ghost entries in
+     *   @ref GlossGhostedVector "vectors with ghost elements"
+     *   or
+     *   @ref GlossGhostCell "ghost cells":
+     *   In both cases, one should
      *   treat the ghost elements or cells as `const` objects that shouldn't
      *   be modified even if the objects allow for calls that modify
      *   properties. Rather, properties should only be modified on processors
@@ -163,8 +166,11 @@ namespace Particles
      *   on both the locally owned cells, as well as on ghost cells. The
      *   particles on the latter are *copies* of particles owned on other
      *   processors, and should therefore be treated in the same way as
-     *   ghost entries in @ref GlossGhostedVector "vectors with ghost elements"
-     *   or @ref GlossGhostCell "ghost cells": In both cases, one should
+     *   ghost entries in
+     *   @ref GlossGhostedVector "vectors with ghost elements"
+     *   or
+     *   @ref GlossGhostCell "ghost cells":
+     *   In both cases, one should
      *   treat the ghost elements or cells as `const` objects that shouldn't
      *   be modified even if the objects allow for calls that modify
      *   properties. Rather, properties should only be modified on processors
@@ -229,8 +235,11 @@ namespace Particles
      *   on both the locally owned cells, as well as on ghost cells. The
      *   particles on the latter are *copies* of particles owned on other
      *   processors, and should therefore be treated in the same way as
-     *   ghost entries in @ref GlossGhostedVector "vectors with ghost elements"
-     *   or @ref GlossGhostCell "ghost cells": In both cases, one should
+     *   ghost entries in
+     *   @ref GlossGhostedVector "vectors with ghost elements"
+     *   or
+     *   @ref GlossGhostCell "ghost cells":
+     *    In both cases, one should
      *   treat the ghost elements or cells as `const` objects that shouldn't
      *   be modified even if the objects allow for calls that modify
      *   properties. Rather, properties should only be modified on processors
@@ -249,8 +258,11 @@ namespace Particles
      *   on both the locally owned cells, as well as on ghost cells. The
      *   particles on the latter are *copies* of particles owned on other
      *   processors, and should therefore be treated in the same way as
-     *   ghost entries in @ref GlossGhostedVector "vectors with ghost elements"
-     *   or @ref GlossGhostCell "ghost cells": In both cases, one should
+     *   ghost entries in
+     *   @ref GlossGhostedVector "vectors with ghost elements"
+     *   or
+     *   @ref GlossGhostCell "ghost cells":
+     *   In both cases, one should
      *   treat the ghost elements or cells as `const` objects that shouldn't
      *   be modified even if the objects allow for calls that modify
      *   properties. Rather, properties should only be modified on processors
@@ -272,8 +284,11 @@ namespace Particles
      *   on both the locally owned cells, as well as on ghost cells. The
      *   particles on the latter are *copies* of particles owned on other
      *   processors, and should therefore be treated in the same way as
-     *   ghost entries in @ref GlossGhostedVector "vectors with ghost elements"
-     *   or @ref GlossGhostCell "ghost cells": In both cases, one should
+     *   ghost entries in
+     *   @ref GlossGhostedVector "vectors with ghost elements"
+     *   or
+     *   @ref GlossGhostCell "ghost cells":
+     *   In both cases, one should
      *   treat the ghost elements or cells as `const` objects that shouldn't
      *   be modified even if the objects allow for calls that modify
      *   properties. Rather, properties should only be modified on processors

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.