]> https://gitweb.dealii.org/ - dealii.git/commitdiff
fix doxygen formatting errors 6753/head
authorTimo Heister <timo.heister@gmail.com>
Wed, 13 Jun 2018 18:43:46 +0000 (14:43 -0400)
committerTimo Heister <timo.heister@gmail.com>
Wed, 13 Jun 2018 18:43:46 +0000 (14:43 -0400)
include/deal.II/base/linear_index_iterator.h
include/deal.II/lac/affine_constraints.h
include/deal.II/lac/arpack_solver.h
include/deal.II/lac/cuda_solver_direct.h
include/deal.II/lac/cuda_sparse_matrix.h
include/deal.II/matrix_free/matrix_free.h

index ac2e1fbb0651c903c898bdf8e7d55c73b502a074..353ca9b13b1bc3b69e815d241ea308ea6ae7ff03 100644 (file)
@@ -57,15 +57,15 @@ DEAL_II_NAMESPACE_OPEN
  *   public:
  *     // const iterators store a const pointer
  *     typedef typename std::conditional<Constness, const Container<T>*,
- Container<T>*>::type
*                                       Container<T>*>::type
  *     container_pointer_type;
  *
  *     // This typedef is assumed to exist.
  *     typedef std::size_t size_type;
  *
  *     // constructor.
- *     Accessor(const container_pointer_type container, const std::ptrdiff_t
- index);
+ *     Accessor(const container_pointer_type container,
*              const std::ptrdiff_t index);
  *
  *     // constructor.
  *     Accessor();
@@ -79,19 +79,18 @@ DEAL_II_NAMESPACE_OPEN
  *
  *     // LinearIndexIterator needs access to linear_index and container.
  *     friend class LinearIndexIterator<Iterator<Constness>,
- Accessor<Constness>>;
*                                      Accessor<Constness>>;
  *   };
  *
  *   template <bool Constness>
  *   class Iterator : public LinearIndexIterator<Iterator<Constness>,
- Accessor<Constness>>
*                                               Accessor<Constness>>
  *   {
  *     // Constructor.
  *     Iterator(Container<T> * const container, const std::ptrdiff_t index);
  *
  *     // implement additional constructors here, but all state should be
- contained
- *     // in the Accessor, which is a member of the base class.
+ *     // contained in the Accessor, which is a member of the base class.
  *   };
  *
  * public:
index c6a3a3e4252c74f24f0ff2cd6d7aa61092b3c25d..f1598df83d29dcf6cbdd7ab711452a5371bcfb57 100644 (file)
@@ -190,7 +190,8 @@ public:
    * constrained inside this AffineConstraints container. In a calculation
    * with a DoFHandler object based on parallel::distributed::Triangulation
    * or parallel::shared::Triangulation, one should use the set of locally
-   * relevant dofs (see @ref GlossLocallyRelevantDof).
+   * relevant dofs (see
+   * @ref GlossLocallyRelevantDof).
    *
    * The given IndexSet allows the AffineConstraints container to save
    * memory by just not caring about degrees of freedom that are not of
index b1b79a9b37ab9ff0a50da603b60380b17a583648..fba27a61cf04701095490514f6c848ff65465f6e 100644 (file)
@@ -160,8 +160,9 @@ dseupd_(int *         rvec,
  * that the diagonals of eliminated matrix rows are all equal to one, you
  * get a single additional eigenvalue. But beware that some functions in
  * deal.II set these diagonals to rather arbitrary (from the point of view
- * of eigenvalue problems) values. See also @ref step_36 "step-36" for an
- * example.
+ * of eigenvalue problems) values. See also
+ * @ref step_36 "step-36"
+ * for an example.
  *
  * @author Baerbel Janssen, Agnieszka Miedlar, 2010, Guido Kanschat 2015, Joscha
  * Gedicke 2016
index 05e96214dd86265fbabdd26d2069af610a67e8e6..86acf16fc2806f1fdb2e7e7205e16f1f6bb07eb5 100644 (file)
@@ -43,6 +43,9 @@ namespace CUDAWrappers
   class SolverDirect
   {
   public:
+    /**
+     * Struct for additional settings for SolverDirect.
+     */
     struct AdditionalData
     {
       /**
@@ -54,9 +57,10 @@ namespace CUDAWrappers
        * Set the solver type. Possibilities are:
        * <ul>
        * <li> "Cholesky" which performs a Cholesky decomposition on the device
-       * </li> <li> "LU_dense" which converts the sparse matrix to a dense
-       * matrix and uses LU factorization </li> <li> "LU_host" which uses LU
-       * factorization on the host </li>
+       * </li>
+       * <li> "LU_dense" which converts the sparse matrix to a dense
+       * matrix and uses LU factorization </li>
+       * <li> "LU_host" which uses LU factorization on the host </li>
        * </ul>
        */
       std::string solver_type;
index dd8446cbdc29ee94cc8a6f05f9b776c908669f7c..b005dfbd7ec3d3c820ed05eb0cf80154b168ffa3 100644 (file)
@@ -269,7 +269,7 @@ namespace CUDAWrappers
      */
     std::tuple<Number *, int *, int *, cusparseMatDescr_t>
     get_cusparse_matrix() const;
-    //*}
+    //@}
 
   private:
     /**
index 02a356569c1eb7306fbf17cafd3bd9acf499fd29..efac0ef5685e579b92a4e425147f32d1f153a824 100644 (file)
@@ -101,7 +101,8 @@ DEAL_II_NAMESPACE_OPEN
  * main features of this framework.
  *
  * For details on usage of this class, see the description of FEEvaluation or
- * the @ref matrixfree "matrix-free module".
+ * the
+ * @ref matrixfree "matrix-free module".
  *
  * @ingroup matrixfree
  *

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.