From: Jean-Paul Pelteret <jppelteret@gmail.com>
Date: Thu, 20 Oct 2016 13:42:16 +0000 (+0200)
Subject: Refactor documentation for TrilinosWrappers::BlockSparsityPattern.
X-Git-Tag: v8.5.0-rc1~553^2
X-Git-Url: https://gitweb.dealii.org/cgi-bin/gitweb.cgi?a=commitdiff_plain;h=d7a30aab0d8c3370aa4025d422ea496f861e3bca;p=dealii.git

Refactor documentation for TrilinosWrappers::BlockSparsityPattern.

The documentation for this class now mirrors that provided in
`petsc_block_sparse_matrix.h` (and, for the namespace description,
`petsc_vector_base.h`).

Fixes #3267
---

diff --git a/include/deal.II/lac/block_sparsity_pattern.h b/include/deal.II/lac/block_sparsity_pattern.h
index 565b7a2c69..70b46225bf 100644
--- a/include/deal.II/lac/block_sparsity_pattern.h
+++ b/include/deal.II/lac/block_sparsity_pattern.h
@@ -562,31 +562,38 @@ public:
   using BlockSparsityPatternBase<DynamicSparsityPattern>::reinit;
 };
 
+/*@}*/
+
 
 #ifdef DEAL_II_WITH_TRILINOS
 
 
-/**
- * This class extends the base class to implement an array of Trilinos
- * sparsity patterns that can be used to initialize Trilinos block sparse
- * matrices that can be distributed among different processors. It is used in
- * the same way as the BlockSparsityPattern except that it builds upon the
- * TrilinosWrappers::SparsityPattern instead of the dealii::SparsityPattern.
- * See the documentation of the BlockSparsityPattern for examples.
- *
- * This class is has properties of the "dynamic" type of
- * @ref Sparsity
- * (in the sense that it can extend the memory if too little elements were
- * allocated), but otherwise is more like the basic deal.II SparsityPattern
- * (in the sense that the method compress() needs to be called before the
- * pattern can be used).
- *
- * This class is used in step-32.
- *
- * @author Martin Kronbichler, 2008, 2009
- */
 namespace TrilinosWrappers
 {
+
+  /*! @addtogroup TrilinosWrappers
+   *@{
+   */
+
+  /**
+   * This class extends the base class to implement an array of Trilinos
+   * sparsity patterns that can be used to initialize Trilinos block sparse
+   * matrices that can be distributed among different processors. It is used in
+   * the same way as the dealii::BlockSparsityPattern except that it builds upon
+   * the TrilinosWrappers::SparsityPattern instead of the
+   * dealii::SparsityPattern.
+   *
+   * This class is has properties of the "dynamic" type of
+   * @ref Sparsity
+   * (in the sense that it can extend the memory if too little elements were
+   * allocated), but otherwise is more like the basic deal.II SparsityPattern
+   * (in the sense that the method compress() needs to be called before the
+   * pattern can be used).
+   *
+   * This class is used in step-32.
+   *
+   * @author Martin Kronbichler, 2008, 2009
+   */
   class BlockSparsityPattern :
     public dealii::BlockSparsityPatternBase<SparsityPattern>
   {
@@ -709,12 +716,13 @@ namespace TrilinosWrappers
      */
     using BlockSparsityPatternBase<SparsityPattern>::reinit;
   };
-}
 
-#endif
+  /*@}*/
 
+} /* namespace TrilinosWrappers */
+
+#endif
 
-/*@}*/
 /*---------------------- Template functions -----------------------------------*/
 
 
diff --git a/include/deal.II/lac/trilinos_vector_base.h b/include/deal.II/lac/trilinos_vector_base.h
index d670f272dc..a80876aa10 100644
--- a/include/deal.II/lac/trilinos_vector_base.h
+++ b/include/deal.II/lac/trilinos_vector_base.h
@@ -53,6 +53,12 @@ template <typename number> class Vector;
  * @addtogroup TrilinosWrappers
  * @{
  */
+
+/**
+* A namespace in which wrapper classes for Trilinos objects reside.
+*
+* @ingroup TrilinosWrappers
+*/
 namespace TrilinosWrappers
 {
   // forward declaration