From: Luca Heltai <luca.heltai@sissa.it>
Date: Fri, 5 Apr 2019 17:36:52 +0000 (+0200)
Subject: Fixed documentation.
X-Git-Tag: v9.1.0-rc1~213^2~4
X-Git-Url: https://gitweb.dealii.org/cgi-bin/gitweb.cgi?a=commitdiff_plain;h=085943837d1fd596249085a0343219de30ef1ed1;p=dealii.git

Fixed documentation.
---

diff --git a/include/deal.II/algorithms/general_data_storage.h b/include/deal.II/algorithms/general_data_storage.h
index ed29057761..30228b9ffa 100644
--- a/include/deal.II/algorithms/general_data_storage.h
+++ b/include/deal.II/algorithms/general_data_storage.h
@@ -98,9 +98,11 @@ public:
   /**
    * Clear all data stored in this class instance.
    *
-   * After this function is called, all copied data owned by this class will
-   * go out of scope. Furthermore, all scoping requirements for data referenced
-   * by this class instance will be lifted.
+   * When you call this function, it destroys all objects you asked to be stored
+   * as copies, and it forgets about the references to data you asked to store
+   * by reference. As a consequence, you are now free to destroy the objects to
+   * which references were stored at whatever time you want -- before or after
+   * the current `GeneralDataStorage` object is destroyed.
    *
    * To clarify this point, consider the following small example:
    *
@@ -289,7 +291,7 @@ public:
   stores_object_with_name(const std::string &name) const;
 
   /**
-   * Find out if we store an object with given name.
+   * Remove the object with given name.
    */
   void
   remove_object_with_name(const std::string &name);