Improve documentation

diff --git a/include/deal.II/base/array_view.h b/include/deal.II/base/array_view.h
index f003e5bad44712368e4f8f9925f20d83feb51cfe..abbc7c308c0d6bfd58c6e723ea6cd86f734eaf14 100644 (file)
--- a/include/deal.II/base/array_view.h
+++ b/include/deal.II/base/array_view.h
@@ -474,9 +474,9 @@ make_array_view (std::vector<ElementType> &vector)
  * initializing an ArrayView object with a pointer to the first element and
  * the size of the given argument.
  *
- * This function is used for @p const references to objects of Vector type
- * because they contain immutable elements. Consequently, the return type of
- * this function is a view to a set of @p const objects.
+ * This function is used for non-@p const references to objects of Vector
+ * type. Such objects contain elements that can be written to. Consequently,
+ * the return type of this function is a view to a set of writable objects.
  *
  * @param[in] vector The Vector for which we want to have an array view
  * object. The array view corresponds to the <em>entire</em> Vector.
@@ -696,7 +696,9 @@ make_array_view (Table<2,ElementType>                           &table,
  * return type of this function is a view to a set of writable objects.
  *
  * @param[in] table The Table for which we want to have an array view object.
- * The array view corresponds to the <em>entire</em> table.
+ * The array view corresponds to the <em>entire</em> table but the order in
+ * which the entries are presented in the array is undefined and can not be
+ * relied upon.
  *
  * @relates ArrayView
  */
@@ -715,13 +717,14 @@ make_array_view (Table<2,ElementType> &table)
  * initializing an ArrayView object with a pointer to the first element of the
  * given table, and the number of table entries as the length of the view.
  *
- * This function is used for non-@p const references to objects of
- * LAPACKFullMatrix type. Such objects contain elements that can be
- * written to. Consequently, the return type of this function is a
- * view to a set of writable objects.
+ * This function is used for @p const references to objects of Table 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 Table for which we want to have an array view object.
- * The array view corresponds to the <em>entire</em> table.
+ * The array view corresponds to the <em>entire</em> table but the order in
+ * which the entries are presented in the array is undefined and can not be
+ * relied upon.
  *
  * @relates ArrayView
  */
@@ -739,12 +742,15 @@ make_array_view (const Table<2,ElementType> &table)
  * initializing an ArrayView object with a pointer to the first element of the
  * given object, and the number entries as the length of the view.
  *
- * This function is used for @p non-const references to objects of Table type
- * because they contain immutable elements. Consequently, the return type of
- * this function is a view to a set of @p non-const objects.
+ * This function is used for @p non-const references to objects of
+ * LAPACKFullMatrix type. Such objects contain elements that can be written to.
+ * 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 view
- * object. The array view corresponds to the <em>entire</em> object.
+ * object. The array view corresponds to the <em>entire</em> object but the
+ * order in which the entries are presented in the array is undefined and can
+ * not be relied upon.
  *
  * @relates ArrayView
  */
@@ -767,7 +773,9 @@ make_array_view (LAPACKFullMatrix<ElementType> &matrix)
  * 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 view
- * object. The array view corresponds to the <em>entire</em> object.
+ * object. The array view corresponds to the <em>entire</em> object but the
+ * order in which the entries are presented in the array is undefined and can
+ * not be relied upon.
  *
  * @relates ArrayView
  */

diff --git a/include/deal.II/base/mpi.h b/include/deal.II/base/mpi.h
index 6854cef75bc7f3dea0b598537bbdc0f6ac149a9b..ddf15d7079dfb91fe407ef664bda6ec8641bffc9 100644 (file)
--- a/include/deal.II/base/mpi.h
+++ b/include/deal.II/base/mpi.h
@@ -53,13 +53,6 @@ DEAL_II_NAMESPACE_OPEN
 template <int rank, int dim, typename Number> class Tensor;
 template <int rank, int dim, typename Number> class SymmetricTensor;
 
-//Forward type declaration to allow MPI sums over Vector<number> type
-template <typename Number> class Vector;
-//Forward type declaration to allow MPI sums over FullMatrix<number> type
-template <typename Number> class FullMatrix;
-//Forward type declaration to allow MPI sums over LAPACKFullMatrix<number> type
-template <typename Number> class LAPACKFullMatrix;
-
 
 namespace Utilities
 {
@@ -156,7 +149,8 @@ namespace Utilities
      * Like the previous function, but take the sums over the elements of an
      * array of type T. In other words, the i-th element of the results
      * array is the sum over the i-th entries of the input arrays from each
-     * processor. T and U must decay to the same type.
+     * processor. T and U must decay to the same type, e.g. they just differ by
+     * one of them having a const type qualifier and the other not.
      *
      * Input and output arrays may be the same.
      */
@@ -226,7 +220,8 @@ namespace Utilities
      * Like the previous function, but take the maximum over the elements of an
      * array of type T. In other words, the i-th element of the results array is
      * the maximum over the i-th entries of the input arrays from each
-     * processor. T and U must decay to the same type.
+     * processor. T and U must decay to the same type, e.g. they just differ by
+     * one of them having a const type qualifier and the other not.
      *
      * Input and output vectors may be the same.
      */
@@ -276,7 +271,8 @@ namespace Utilities
      * Like the previous function, but take the minima over the elements of an
      * array of type T. In other words, the i-th element of the results
      * array is the minimum of the i-th entries of the input arrays from each
-     * processor. T and U must decay to the same type.
+     * processor. T and U must decay to the same type, e.g. they just differ by
+     * one of them having a const type qualifier and the other not.
      *
      * Input and output arrays may be the same.
      */