[haiku-commits] haiku: hrev52296 - docs/user/app

  • From: Adrien Destugues <pulkomandy@xxxxxxxxxxxxx>
  • To: haiku-commits@xxxxxxxxxxxxx
  • Date: Tue, 28 Aug 2018 13:15:30 -0400 (EDT)

hrev52296 adds 1 changeset to branch 'master'
old head: 372195500ddc3a88c8a30f63824c7b63a3c4ab25
new head: 03e5dd5273ae9bcef15db099630c4c8cf8b7bbdc
overview: 
https://git.haiku-os.org/haiku/log/?qt=range&q=03e5dd5273ae+%5E372195500ddc

----------------------------------------------------------------------------

03e5dd5273ae: Fix documentation for BMessage::Previous
  
  The function allocates a message because it uses lazy initialization,
  however the user does not get ownership and must not delete it.
  
  Fixes #14413.

                             [ Adrien Destugues <pulkomandy@xxxxxxxxxxxxx> ]

----------------------------------------------------------------------------

Revision:    hrev52296
Commit:      03e5dd5273ae9bcef15db099630c4c8cf8b7bbdc
URL:         https://git.haiku-os.org/haiku/commit/?id=03e5dd5273ae
Author:      Adrien Destugues <pulkomandy@xxxxxxxxxxxxx>
Date:        Tue Aug 28 17:13:38 2018 UTC

Ticket:      https://dev.haiku-os.org/ticket/14413

----------------------------------------------------------------------------

1 file changed, 4 insertions(+), 3 deletions(-)
docs/user/app/Message.dox | 7 ++++---

----------------------------------------------------------------------------

diff --git a/docs/user/app/Message.dox b/docs/user/app/Message.dox
index 16f0a568dd..c6204ddb6b 100644
--- a/docs/user/app/Message.dox
+++ b/docs/user/app/Message.dox
@@ -463,9 +463,10 @@
        \brief Get the message to which this message is a reply.
 
        \return Returns a new BMessage with the same data stuctures as the 
message
-               to which this message is a reply. You get the ownership of this
-               message, so free it when you're done. If this message isn't a
-               reply to another message, this method will return \c NULL.
+               to which this message is a reply. The pointer is only valid as
+                       long as this message is still allocated, you do not get 
ownership.
+                       If this message isn't a reply to another message, this 
method will
+                       return \c NULL.
 
        \since BeOS R3
 */


Other related posts:

  • » [haiku-commits] haiku: hrev52296 - docs/user/app - Adrien Destugues