]> https://gitweb.dealii.org/ - dealii.git/commitdiff
Document some return values a bit better
authorDaniel Arndt <daniel.arndt@iwr.uni-heidelberg.de>
Mon, 18 Feb 2019 17:30:50 +0000 (18:30 +0100)
committerDaniel Arndt <daniel.arndt@iwr.uni-heidelberg.de>
Wed, 20 Feb 2019 12:46:19 +0000 (13:46 +0100)
include/deal.II/lac/trilinos_sparse_matrix.h

index 4f8e955cb869d140bdc763af23561d5dbefb9a39..183875e6bec35da18f751875ff4c907ddcab422b 100644 (file)
@@ -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,

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.