]> https://gitweb.dealii.org/ - dealii.git/commitdiff
Mark code spans in documentation of is_consistent_in_parallel(). 17161/head
authorMarc Fehling <mafehling.git@gmail.com>
Fri, 21 Jun 2024 10:47:49 +0000 (12:47 +0200)
committerMarc Fehling <mafehling.git@gmail.com>
Fri, 21 Jun 2024 17:03:38 +0000 (19:03 +0200)
include/deal.II/lac/affine_constraints.h

index 8458098facb2d4aac3ce1cb1eddc285f66d0e09f..30a058e4de859e46268c6e73eacdc1fcaeb6d32d 100644 (file)
@@ -1961,18 +1961,18 @@ public:
    *
    * This method checks if all processors agree on the constraints for their
    * local lines as given by @p locally_active_dofs. This method is a collective
-   * operation and will return @p true only if all processors are consistent.
+   * operation and will return `true` only if all processors are consistent.
    *
    * Please supply the owned DoFs per processor as returned by
-   * Utilities::MPI::all_gather(MPI_Comm, DoFHandler::locally_owned_dofs()) as
+   * `Utilities::MPI::all_gather(MPI_Comm, DoFHandler::locally_owned_dofs())` as
    * @p locally_owned_dofs and the result of
    * DoFTools::extract_locally_active_dofs() as
    * @p locally_active_dofs. The former is used to determine ownership of the
    * specific DoF, while the latter is used as the set of rows that need to be
    * checked.
    *
-   * If @p verbose is set to @p true, additional debug information is written
-   * to std::cout.
+   * If @p verbose is set to `true`, additional debug information is written
+   * to `std::cout`.
    *
    * @note This method exchanges all constraint information of locally active
    * lines and is as such slow for large computations and should probably

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.