]> https://gitweb.dealii.org/ - dealii.git/commitdiff
Improve dopcumentation 8633/head
authorDaniel Arndt <arndtd@ornl.gov>
Fri, 23 Aug 2019 22:38:29 +0000 (18:38 -0400)
committerDaniel Arndt <arndtd@ornl.gov>
Fri, 23 Aug 2019 22:38:29 +0000 (18:38 -0400)
include/deal.II/lac/diagonal_matrix.h

index 86d96250dbdb3c26a452dbdb141cfad12ffdbdec..8adc079b36212910a8668eb2ecd4a9ea70014883 100644 (file)
@@ -58,7 +58,9 @@ public:
   DiagonalMatrix() = default;
 
   /**
-   * Constructor immediately initializing the object properly.
+   * Constructor initializing this object as a diagonal matrix of size `n x n`
+   * where `n` is the size of the vector, and with diagonal entries equal to the
+   * elements of @p vec.
    */
   explicit DiagonalMatrix(const VectorType &vec);
 

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.