]> https://gitweb.dealii.org/ - dealii.git/commitdiff
Fixed documentation.
authorLuca Heltai <luca.heltai@sissa.it>
Fri, 5 Apr 2019 17:36:52 +0000 (19:36 +0200)
committerJean-Paul Pelteret <jppelteret@gmail.com>
Sun, 7 Apr 2019 06:33:21 +0000 (08:33 +0200)
include/deal.II/algorithms/general_data_storage.h

index ed290577616109c41211b77b5d47569f5edbad25..30228b9ffa8d4d05a0076816cc04158fab84b598 100644 (file)
@@ -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);

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.