]> https://gitweb.dealii.org/ - dealii.git/commitdiff
Update thread_management.h 6135/head
authorWolfgang Bangerth <bangerth@colostate.edu>
Mon, 2 Apr 2018 16:17:00 +0000 (10:17 -0600)
committerGitHub <noreply@github.com>
Mon, 2 Apr 2018 16:17:00 +0000 (10:17 -0600)
include/deal.II/base/thread_management.h

index 087a49cb2483e8bbeb15cc8707bb8c0d98268ba5..b2f534225ba6c9e09f583a5129c838e1f7deaf31 100644 (file)
@@ -1047,7 +1047,7 @@ namespace Threads
      *   int i = t.return_value();   // i is now 42
      * @endcode
      * You will rarely have a need to write such code. On the other hand,
-     * the function needs to return a writable reference to support
+     * the function needs to return a writable (non-@p const) reference to support
      * code such as this:
      * @code
      *   std::unique_ptr<int> create_int (const std::string &s) { ... }
@@ -1066,7 +1066,7 @@ namespace Threads
      * <code>std::unique_ptr</code> objects can not be copied. In other words,
      * to get the pointer out of the object returned from the thread, it needs
      * to be moved, and in order to be moved, the current function needs to
-     * return a writable reference.
+     * return a writable (non-@p const) reference.
      */
     typename internal::return_value<RT>::reference_type
     return_value ()
@@ -1754,7 +1754,7 @@ namespace Threads
      *   int i = t.return_value();   // i is now 42
      * @endcode
      * You will rarely have a need to write such code. On the other hand,
-     * the function needs to return a writable reference to support
+     * the function needs to return a writable (non-@p const) reference to support
      * code such as this:
      * @code
      *   std::unique_ptr<int> create_int (const std::string &s) { ... }
@@ -1773,7 +1773,7 @@ namespace Threads
      * <code>std::unique_ptr</code> objects can not be copied. In other words,
      * to get the pointer out of the object returned from the task, it needs
      * to be moved, and in order to be moved, the current function needs to
-     * return a writable reference.
+     * return a writable (non-@p const) reference.
      *
      * @pre You can't call this function if you have used the default
      * constructor of this class and have not assigned a task object to it. In

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.