From: Timo Heister <timo.heister@gmail.com>
Date: Thu, 13 Sep 2018 01:41:06 +0000 (-0400)
Subject: document LA and distributed namespaces
X-Git-Tag: v9.1.0-rc1~723^2~1
X-Git-Url: https://gitweb.dealii.org/cgi-bin/gitweb.cgi?a=commitdiff_plain;h=97d284e1299696ed479bb3e7fceab7793c71074e;p=dealii.git

document LA and distributed namespaces

otherwise they are not clickable in doxygen
---

diff --git a/include/deal.II/lac/la_parallel_vector.h b/include/deal.II/lac/la_parallel_vector.h
index b7ea752085..af8f759df8 100644
--- a/include/deal.II/lac/la_parallel_vector.h
+++ b/include/deal.II/lac/la_parallel_vector.h
@@ -35,6 +35,9 @@ DEAL_II_NAMESPACE_OPEN
 
 namespace LinearAlgebra
 {
+  /**
+   * A namespace for parallel implementations of vectors.
+   */
   namespace distributed
   {
     template <typename>
diff --git a/include/deal.II/lac/la_vector.h b/include/deal.II/lac/la_vector.h
index c5299acb4b..be07fcaa10 100644
--- a/include/deal.II/lac/la_vector.h
+++ b/include/deal.II/lac/la_vector.h
@@ -46,6 +46,20 @@
 
 DEAL_II_NAMESPACE_OPEN
 
+/**
+ * A namespace for vector classes.
+ *
+ * This namespace contains various classes that provide wrappers to vector
+ * classes from different external libraries like Trilinos (EPetra) or PETSc
+ * and native implementations like LinearAlgebra::distributed::Vector.
+ *
+ * The different vector classes are derived from VectorSpaceVector to provide
+ * a joint interface for vector space operations, are derived from
+ * ReadWriteVector (or ReadWriteVector itself), or both. The separation of
+ * vector space operations (like norms or vector additions) through
+ * VectorSpaceVector and element access through ReadWriteVector are by design
+ * and improve performance.
+ */
 namespace LinearAlgebra
 {
   /*! @addtogroup Vectors
diff --git a/include/deal.II/lac/trilinos_epetra_vector.h b/include/deal.II/lac/trilinos_epetra_vector.h
index b6a4bfd5c4..5e8ab4358c 100644
--- a/include/deal.II/lac/trilinos_epetra_vector.h
+++ b/include/deal.II/lac/trilinos_epetra_vector.h
@@ -42,6 +42,9 @@ namespace LinearAlgebra
   template <typename Number>
   class ReadWriteVector;
 
+  /**
+   * A namespace for classes that provide wrappers for Epetra from Trilinos.
+   */
   namespace EpetraWrappers
   {
     /**