]> https://gitweb.dealii.org/ - dealii.git/commitdiff
doxygen fixes 6319/head
authorTimo Heister <timo.heister@gmail.com>
Tue, 24 Apr 2018 20:27:50 +0000 (16:27 -0400)
committerTimo Heister <timo.heister@gmail.com>
Tue, 24 Apr 2018 20:27:50 +0000 (16:27 -0400)
warnings/errors that appear during doxygen generation

doc/news/changes/minor/20180321MatthiasMaier
include/deal.II/base/array_view.h
include/deal.II/base/partitioner.h
include/deal.II/base/quadrature_lib.h
include/deal.II/distributed/shared_tria.h
include/deal.II/grid/grid_tools.h
include/deal.II/matrix_free/cuda_fe_evaluation.h
include/deal.II/matrix_free/evaluation_selector.h
include/deal.II/optimization/rol/vector_adaptor.h
include/deal.II/sundials/arkode.h

index ad91a4bb21ff71beced3a5934780de04fc1dac51..a87f072f3358d422bb196998816ceaf81b884fe5 100644 (file)
@@ -1,9 +1,9 @@
 New: Added a third test variant to the testsuite driver: For a test
 consisting of a test.prm.in (and a test.output) file the test.prm.in file
 will be configured/preprocessed to a test.prm file. This is done with the
-CMake macro CONFIGURE_FILE that replaces all strings @VARIABLE@ with the
+CMake macro CONFIGURE_FILE that replaces all strings \@VARIABLE\@ with the
 contents of the corresponding CMake variable. This is useful in particular
-to conveniently substitute @SOURCE_DIR@ with the full source directory path
+to conveniently substitute \@SOURCE_DIR\@ with the full source directory path
 of the test.
 <br>
 (Matthias Maier, 2018/03/21)
index ea3581f9b1d6921118f5109b0ca92e8ed7ab4717..3ef61ed3f4c4d1f9b1665fd83303e294955489fc 100644 (file)
@@ -947,7 +947,7 @@ make_array_view (const Table<2,ElementType> &table)
  * Consequently, the return type of this function is a view to a set of
  * @p non-const objects.
  *
- * @param[in] table The LAPACKFullMatrix for which we want to have an array
+ * @param[in] matrix The LAPACKFullMatrix for which we want to have an array
  * view object. The array view corresponds to the <em>entire</em> object but
  * the order in which the entries are presented in the array is an
  * implementation detail and should not be relied upon.
@@ -973,7 +973,7 @@ make_array_view (LAPACKFullMatrix<ElementType> &matrix)
  * type because they contain immutable elements. Consequently, the return type
  * of this function is a view to a set of @p const objects.
  *
- * @param[in] table The LAPACKFullMatrix for which we want to have an array
+ * @param[in] matrix The LAPACKFullMatrix for which we want to have an array
  * view object. The array view corresponds to the <em>entire</em> object but
  * the order in which the entries are presented in the array is an
  * implementation detail and should not be relied upon.
index 1429531f26b76321a4393712a377f03c72690691..aa29e72685e437c3f62654c19748b93f64d51f1d 100644 (file)
@@ -496,7 +496,7 @@ namespace Utilities
        * @p ghost_array to zero for the implementation-dependent cases when it
        * was not already done in the import_from_ghosted_array_start() call.
        *
-       * @param locally_owned_array The array of data where the resulting data
+       * @param locally_owned_storage The array of data where the resulting data
        * sent by remote processes to the calling process will be accumulated
        * into.
        *
@@ -511,7 +511,7 @@ namespace Utilities
       template <typename Number>
       void
       import_from_ghosted_array_finish(const VectorOperation::values  vector_operation,
-                                       const ArrayView<const Number> &temporary_array,
+                                       const ArrayView<const Number> &temporary_storage,
                                        const ArrayView<Number>       &locally_owned_storage,
                                        const ArrayView<Number>       &ghost_array,
                                        std::vector<MPI_Request>      &requests) const;
index a72296f2cf7950c82c31739464112c3fba92215d..6a31b4308b545b886348061b36d48efd72b5a221 100644 (file)
@@ -705,7 +705,7 @@ public:
  * \begin{pmatrix}
  * \hat x^\beta (1-\hat y)\\
  * \hat x^\beta \hat y
- * end{pmatrix}
+ * \end{pmatrix}
  * \f]
  *
  * with determinant of the Jacobian equal to $J= \beta \hat \x^{2\beta-1}$.
@@ -748,7 +748,7 @@ public:
    * Call the above constructor with QGauss<1>(n) quadrature formulas for
    * both the radial and angular quadratures.
    *
-   * @param n
+   * @param n Order of QGauss quadrature
    */
   QDuffy(const unsigned int n,
          const double beta);
index 062d05b7963bc64c5a8a0d1f53f195ca133ac303..1ed6a8ee1539abfbf812779fab51234d4bd0b6f6 100644 (file)
@@ -112,12 +112,12 @@ namespace parallel
        *
        * The constructor requires that exactly one of
        * <code>partition_auto</code>, <code>partition_metis</code>,
-       * <code>partition_zorder</code>, <code>partition_zoltan> and
+       * <code>partition_zorder</code>, <code>partition_zoltan</code> and
        * <code>partition_custom_signal</code> is set. If
        * <code>partition_auto</code> is chosen, it will use
        * <code>partition_zoltan</code> (if available), then
        * <code>partition_metis</code> (if available) and finally
-       * <code>partition_zorder>.
+       * <code>partition_zorder</code>.
        */
       enum Settings
       {
index 9b3119e1d273eef14e8292860f7a02f0dfa3dd69..b5df22b7cb1bb89fd2897cf0dfaa841775b6cbe4 100644 (file)
@@ -220,7 +220,7 @@ namespace GridTools
   BoundingBox<spacedim> compute_bounding_box(const Triangulation<dim, spacedim> &triangulation);
 
   /**
-   * Return the point on the geometrical object @object closest to the given
+   * Return the point on the geometrical object @object closest to the given
    * point @p trial_point. For example, if @p object is a one-dimensional line
    * or edge, then the returned point will be a point on the geodesic that
    * connects the vertices as the manifold associated with the object sees it
@@ -643,7 +643,7 @@ namespace GridTools
    *  - Cells, is a vector of a vector cells of the all cells
    *   containing at least one of the @p points .
    *  - A vector qpoints of vector of points, containing in @p qpoints[i]
-   *   the reference positions of all points that fall within the cell @P cells[i] .
+   *   the reference positions of all points that fall within the cell @p cells[i] .
    *  - A vector indices of vector of integers, containing the mapping between
    *   local numbering in qpoints, and global index in points
    *
@@ -712,7 +712,7 @@ namespace GridTools
    * - cells : a vector of cells of the all cells containing at
    *  least a point.
    * - qpoints : a vector of vector of points; containing in @p qpoints[i]
-   *   the reference positions of all points that fall within the cell @P cells[i] .
+   *   the reference positions of all points that fall within the cell @p cells[i] .
    * - maps : a vector of vector of integers, containing the mapping between
    *  the numbering in qpoints (previous element of the tuple), and the vector
    *  of local points of the process owning the points.
index 40044b83bc7f46d3e0c3a730b04ae4adce3388cf..3b8037793d6351ba3e91a7e8429669196ef70d09 100644 (file)
@@ -49,7 +49,7 @@ namespace CUDAWrappers
    *
    * This class has five template arguments:
    *
-   * @ptaram dim Dimension in which this class is to be used
+   * @tparam dim Dimension in which this class is to be used
    *
    * @tparam fe_degree Degree of the tensor prodict finite element with fe_degree+1
    * degrees of freedom per coordinate direction
index 0215bf0a3bc5ddd653b9aae3485bf1ceacd44a4a..6422c7561e7f7f73d6a6a81f322130a19bd980d8 100644 (file)
@@ -355,7 +355,7 @@ struct SelectEvaluator<dim, -1, n_q_points_1d, n_components, Number>
                        const bool               evaluate_hessians);
 
   /**
-   * Based on the the run time parameters stored in @shape_info this function
+   * Based on the the run time parameters stored in @shape_info this function
    * chooses an appropriate evaluation strategy for the integrate function, i.e.
    * this calls internal::FEEvaluationImpl::integrate(),
    * internal::FEEvaluationImplCollocation::integrate() or
index dc411c67957d2841793f27d93df374a904a39067..24725a3d4a344171cfe112d05def0561792c441e 100644 (file)
@@ -198,7 +198,7 @@ namespace Rol
     value_type dot (const ROL::Vector<value_type> &rol_vector) const;
 
     /**
-     * Return the \f$ L^{2} \f$ norm of the wrapped vector.
+     * Return the $L^{2}$ norm of the wrapped vector.
      *
      * The returned type is of VectorAdaptor::value_type so as to maintain
      * consistency with ROL::Vector<VectorAdaptor::value_type> and
@@ -215,7 +215,7 @@ namespace Rol
 
     /**
      * Create and return a Teuchos smart reference counting pointer to the basis
-     * vector corresponding to the @p i \f${}^{th}\f$ element of
+     * vector corresponding to the @p i ${}^{th}$ element of
      * the wrapper vector.
      */
     Teuchos::RCP<ROL::Vector<value_type>> basis (const int i) const;
index bcbc785f65afaa78bb94c6b43f5641cc4730ec32..441853650170e4c62f7d4d95920355912c73c257 100644 (file)
@@ -142,14 +142,14 @@ namespace SUNDIALS
    * \f]
    * must be solved for each stage $z_i , i = 1, \ldot, s$, where
    * we have the data
-   * \[
+   * \f[
    *  a_i :=  M y_{n−1} + h_n \sum_{j=1}^{i−1} [ A^E_{i,j} f_E(t^E_{n,j}, z_j)
    *  + A^I_{i,j} f_I (t^I_{n,j}, z_j)]
-   * \]
+   * \f]
    * for the ARK methods, or
-   * \[
+   * \f[
    *  a_i :=  M y_{n−1} + h_n \sum_{j=1}^{i−1} A^I_{i,j} f_I (t^I_{n,j}, z_j)
-   * \]
+   * \f]
    * for the DIRK methods. Here $A^I_{i,j}$ and $A^E_{i,j}$ are the Butcher's
    * tables for the chosen solver.
    *
@@ -161,25 +161,25 @@ namespace SUNDIALS
    *
    * For systems of either type, ARKode allows a choice of solution strategy.
    * The default solver choice is a variant of Newton’s method,
-   * \[
+   * \f[
    *  z_i^{m+1} = z_i^m +\delta^{m+1},
-   * \]
+   * \f]
    * where $m$ is the Newton index, and the Newton update $\delta^{m+1}$
    * requires the solution of the linear Newton system
-   * \[
+   * \f[
    *  N(z_i^m) \delta^{m+1} = -G(z_i^m),
-   * \]
+   * \f]
    * where
-   * \[
+   * \f[
    * N := M - \gamma J, \quad J := \frac{\partial f_I}{\partial y},
    * \qquad \gamma:= h_n A^I_{i,i}.
-   * \]
+   * \f]
    *
    * As an alternate to Newton’s method, ARKode may solve for each stage $z_i ,i
    * = 1, \ldots , s$ using an Anderson-accelerated fixed point iteration
-   * \[
+   * \f[
    * z_i^{m+1} = g(z_i^{m}), m=0,1,\ldots.
-   * \]
+   * \f]
    *
    * Unlike with Newton’s method, this option does not require the solution of
    * a linear system at each iteration, instead opting for solution of a

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.