From: Daniel Arndt <daniel.arndt@iwr.uni-heidelberg.de>
Date: Mon, 18 Feb 2019 17:30:50 +0000 (+0100)
Subject: Document some return values a bit better
X-Git-Tag: v9.1.0-rc1~309^2~9
X-Git-Url: https://gitweb.dealii.org/cgi-bin/gitweb.cgi?a=commitdiff_plain;h=8fa282a2c8ca4dc339fce857d0d8d085b3cd3d93;p=dealii.git

Document some return values a bit better
---

diff --git a/include/deal.II/lac/trilinos_sparse_matrix.h b/include/deal.II/lac/trilinos_sparse_matrix.h
index 4f8e955cb8..183875e6be 100644
--- a/include/deal.II/lac/trilinos_sparse_matrix.h
+++ b/include/deal.II/lac/trilinos_sparse_matrix.h
@@ -1578,6 +1578,7 @@ namespace TrilinosWrappers
      *
      * This function will be called when the underlying number type for the
      * matrix object and the one for the vector object are the same.
+     * Despite looking complicated, the return type is just `void`.
      *
      * In case of a serial vector, this function will only work when
      * running on one processor, since the matrix object is inherently
@@ -1592,6 +1593,7 @@ namespace TrilinosWrappers
      * Same as the function above for the case that the underlying number type
      * for the matrix object and the one for the vector object do not coincide.
      * This case is not implemented. Calling it will result in a runtime error.
+     * Despite looking complicated, the return type is just `void`.
      */
     template <typename VectorType>
     typename std::enable_if<!std::is_same<typename VectorType::value_type,
@@ -1610,6 +1612,7 @@ namespace TrilinosWrappers
      *
      * This function will be called when the underlying number type for the
      * matrix object and the one for the vector object are the same.
+     * Despite looking complicated, the return type is just `void`.
      */
     template <typename VectorType>
     typename std::enable_if<std::is_same<typename VectorType::value_type,
@@ -1620,6 +1623,7 @@ namespace TrilinosWrappers
      * Same as the function above for the case that the underlying number type
      * for the matrix object and the one for the vector object do not coincide.
      * This case is not implemented. Calling it will result in a runtime error.
+     * Despite looking complicated, the return type is just `void`.
      */
     template <typename VectorType>
     typename std::enable_if<!std::is_same<typename VectorType::value_type,