From: Wolfgang Bangerth Date: Wed, 24 Aug 2016 12:24:16 +0000 (-0600) Subject: Update documentation of VectorMemory::Pointer. X-Git-Tag: v8.5.0-rc1~740^2 X-Git-Url: https://gitweb.dealii.org/cgi-bin/gitweb.cgi?a=commitdiff_plain;h=refs%2Fpull%2F3008%2Fhead;p=dealii.git Update documentation of VectorMemory::Pointer. --- diff --git a/include/deal.II/lac/vector_memory.h b/include/deal.II/lac/vector_memory.h index 88f084f9b9..a63424cd3d 100644 --- a/include/deal.II/lac/vector_memory.h +++ b/include/deal.II/lac/vector_memory.h @@ -106,10 +106,17 @@ public: //@} /** - * Pointer to vectors allocated from VectorMemory objects. This pointer is - * safe in the sense that it automatically calls free() when it is - * destroyed, thus relieving the user from using vector management functions - * at all. + * A class that looks like a pointer for all practical purposes and that + * upon construction time allocates a vector from a VectorMemory object + * (or an object of a derived class) that is passed to the constructor. + * The destructor then automatically returns the vector's ownership to + * the same VectorMemory object. + * + * Pointers of this type are therefore safe in the sense that they automatically + * call VectorMemory::free() when they are destroyed, whether that happens + * at the end of a code block or because local variables are destroyed during + * exception unwinding. These kinds of object thus relieve the user from + * using vector management functions explicitly. * * @author Guido Kanschat, 2009 */ @@ -139,11 +146,13 @@ public: * Dereferencing operator. */ VectorType *operator -> () const; + private: /** * The memory pool used. */ SmartPointer,Pointer> pool; + /** * The pointer to the vector. */