Correct the Ptr (T *ptr) documentation.
authorGustavo J. A. M. Carneiro <gjcarneiro@gmail.com>
Sat, 19 May 2007 14:37:06 +0100
changeset 664 b6aed9871c69
parent 663 48c05ee9fb6a
child 665 6eb8f44439b0
Correct the Ptr (T *ptr) documentation.
src/core/ptr.h
--- a/src/core/ptr.h	Fri May 18 14:08:51 2007 -0700
+++ b/src/core/ptr.h	Sat May 19 14:37:06 2007 +0100
@@ -73,11 +73,12 @@
   /**
    * \param ptr raw pointer to manage
    *
-   * Create a smart pointer which points to the
-   * input raw pointer. This method takes ownershipt
-   * of the input raw pointer. That is, the smart pointer
-   * becomes responsible for calling delete on the
-   * raw pointer when needed.
+   * Create a smart pointer which points to the object pointed to by
+   * the input raw pointer ptr. This method creates its own reference
+   * to the pointed object. The caller is responsible for Unref()'ing
+   * its own reference, and the smart pointer will eventually do the
+   * same, so that object is deleted if no more references to it
+   * remain.
    */
   Ptr (T *ptr);
   Ptr (Ptr const&o);