]> https://gitweb.dealii.org/ - dealii.git/commitdiff
Augment the documentation of operator<< for Vector. 10046/head
authorWolfgang Bangerth <bangerth@colostate.edu>
Wed, 6 May 2020 15:41:02 +0000 (09:41 -0600)
committerWolfgang Bangerth <bangerth@colostate.edu>
Wed, 6 May 2020 15:41:02 +0000 (09:41 -0600)
include/deal.II/lac/vector.h

index 3893218ab1cce93dafc07fe553d8bfcd4a81c972..e9dfe66aaf5620c2d9e392f23bd0c86a76be5b75 100644 (file)
@@ -1365,7 +1365,11 @@ swap(Vector<Number> &u, Vector<Number> &v)
 
 
 /**
- * Output operator writing a vector to a stream.
+ * Output operator writing a vector to a stream. This operator outputs the
+ * elements of the vector one by one, with a space between entries. Each entry
+ * is formatted according to the flags set on the output stream.
+ *
+ * @relatesalso Vector
  */
 template <typename number>
 inline std::ostream &
@@ -1389,6 +1393,7 @@ operator<<(std::ostream &out, const Vector<number> &v)
 /**
  * Declare dealii::Vector< Number > as serial vector.
  *
+ * @relatesalso Vector
  * @author Uwe Koecher, 2017
  */
 template <typename Number>

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.