]> https://gitweb.dealii.org/ - dealii.git/commitdiff
A variety of doxygen fixes. 15129/head
authorWolfgang Bangerth <bangerth@colostate.edu>
Sat, 22 Apr 2023 00:28:12 +0000 (18:28 -0600)
committerWolfgang Bangerth <bangerth@colostate.edu>
Sat, 22 Apr 2023 22:07:47 +0000 (16:07 -0600)
include/deal.II/distributed/grid_refinement.h
include/deal.II/fe/fe_p1nc.h
include/deal.II/grid/grid_refinement.h
include/deal.II/lac/petsc_communication_pattern.h

index 9ef0a5c6d59f0a061bfc075b2bd5b252b4e56028..1aef1a106b47d026512ef6df2cc748a28ed8b608 100644 (file)
@@ -68,7 +68,9 @@ namespace internal
           /**
            * Compute a threshold value so that the error accumulated over all
            * criteria[i] so that
+           * @code
            *     criteria[i] > threshold
+           * @endcode
            * is larger than target_error.
            */
           template <typename number>
index 026083328305813d2008d0c59de7a9aecb2ed86c..a8830e3a245d79d9199bb8fb5847838351f79ad4 100644 (file)
@@ -301,8 +301,8 @@ private:
    * Do the work which is needed before cellwise data computation.
    * Since the shape functions are constructed independently on each cell,
    * the data on the reference cell is not necessary.
-   * It returns an empty variable type of @ InternalDataBase and updates @
-   * update_flags, and computes trivially zero Hessian for each cell if it is
+   * It returns an empty variable of type @p InternalDataBase and stores
+   * @p update_flags, and computes trivially zero Hessian for each cell if it is
    * needed.
    */
   virtual std::unique_ptr<FiniteElement<2, 2>::InternalDataBase>
index b9996eb83f1395498b5d40935bef2123ebe9fdd8..39c348fc36796d170eeab34b6e6679d73cd54bf7 100644 (file)
@@ -66,11 +66,11 @@ namespace GridRefinement
    * @param[in] max_n_cells The maximal number of cells. If current cell
    * number @p current_n_cells is already exceeded maximal cell number @p
    * max_n_cells, refinement fraction of cells will be set to zero and
-   * coarsening fraction of cells will be adjusted to reduce cell number to @
-   * max_n_cells. If cell number is going to be exceeded only upon refinement,
-   * then refinement and coarsening fractions are going to be adjusted with a
-   * same ratio in an attempt to reach the maximum number of cells. Be aware
-   * though that through proliferation of refinement due to
+   * coarsening fraction of cells will be adjusted to reduce cell number to
+   * @p max_n_cells. If cell number is going to be exceeded only upon
+   * refinement, then refinement and coarsening fractions are going to be
+   * adjusted with a same ratio in an attempt to reach the maximum number of
+   * cells. Be aware though that through proliferation of refinement due to
    * Triangulation::MeshSmoothing, this number is only an indicator. The
    * default value of this argument is to impose no limit on the number of
    * cells.
index 4670f9ea55310280abd52b96e49a110a6840e59c..619801e2c611f76ae7cc5f393f03148ad52d7eb7 100644 (file)
@@ -232,8 +232,8 @@ namespace PETScWrappers
 
     /**
      * Reinitialize the partitioner. As for the Utilities::MPI::Partitioner,
-     * any entry of @p ghost_indices that is also present in @
-     * locally_owned_indices is discarded.
+     * any entry of @p ghost_indices that is also present in
+     * @p locally_owned_indices is discarded.
      */
     virtual void
     reinit(const IndexSet &locally_owned_indices,
@@ -242,9 +242,9 @@ namespace PETScWrappers
 
     /**
      * Reinitialize the partitioner. As for the Utilities::MPI::Partitioner,
-     * any entry of @p ghost_indices that is also present in @
-     * locally_owned_indices is discarded. This reinitialization will allow to
-     * perform communications either using a ghost data array of the size
+     * any entry of @p ghost_indices that is also present in
+     * @p locally_owned_indices is discarded. This reinitialization will allow
+     * to perform communications either using a ghost data array of the size
      * of @p ghost_indices or of @p larger_ghost_indices.
      */
     void

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.