/soc/2013/ankitkv/gobjectification: 618830ebcdcb: Added a note a...

[Ankit Vani]

Changeset: 618830ebcdcb121daa4bfe7a742fe26475e2e529
Author:	 Ankit Vani <a at nevitus.org>
Date:	 2013-07-14 19:16 +0530
Branch:	 soc.2013.gobjectification
URL: https://hg.pidgin.im/soc/2013/ankitkv/gobjectification/rev/618830ebcdcb

Description:

Added a note about destruction of a conversation in PurpleConversation's documentation

diffstat:

 libpurple/conversation.h |  5 +++++
 1 files changed, 5 insertions(+), 0 deletions(-)

diffs (15 lines):

diff --git a/libpurple/conversation.h b/libpurple/conversation.h
--- a/libpurple/conversation.h
+++ b/libpurple/conversation.h
@@ -119,6 +119,11 @@ typedef enum /*< flags >*/
  * A core representation of a conversation between two or more people.
  *
  * The conversation can be an IM or a chat.
+ *
+ * @note When a conversation is destroyed with g_object_unref(), the specified
+ *       conversation is removed from the parent window. If this conversation is
+ *       the only one contained in the parent window, that window is also
+ *       destroyed.
  */
 struct _PurpleConversation
 {