doc for add_data_vector

git-svn-id: https://svn.dealii.org/trunk@2582 0785d39b-7218-0410-832d-ea1e28bc413d

diff --git a/deal.II/deal.II/include/numerics/data_out.h b/deal.II/deal.II/include/numerics/data_out.h
index e3a9329b07dfafe65707d27b8d400263df8763fd..3da100fad5d1b79d8e4710c63ed077fea72e3927 100644 (file)
--- a/deal.II/deal.II/include/numerics/data_out.h
+++ b/deal.II/deal.II/include/numerics/data_out.h
@@ -196,6 +196,14 @@ class DataOut_DoFData : public DataOutInterface<dim>
                                      * conversion of the #name# to a vector
                                      * of strings, to the other
                                      * #add_data_vector# function above.
+                                     *
+                                     * If #data# is a vector with
+                                     * multiple components this
+                                     * function will generate
+                                     * distinct names for all
+                                     * components by appending an
+                                     * underscore and the number of
+                                     * each component to #name#
                                      */
     void add_data_vector (const Vector<double> &data,
                          const string         &name);