/soc/2012/michael/android: b8732f4926cb: Added PurpleMessage doc...

[Michael Zangl]

Changeset: b8732f4926cb58b8dde944e9f15e734367d18395
Author:	 Michael Zangl <michael at soc.pidgin.im>
Date:	 2012-08-20 16:01 +0200
Branch:	 soc.2012.android
URL: http://hg.pidgin.im/soc/2012/michael/android/rev/b8732f4926cb

Description:

Added PurpleMessage documentation.

diffstat:

 android/workspace/im.pidgin.libpurple/src/im/pidgin/libpurple/conversation/PurpleMessage.java |  10 ++++++++--
 1 files changed, 8 insertions(+), 2 deletions(-)

diffs (34 lines):

diff --git a/android/workspace/im.pidgin.libpurple/src/im/pidgin/libpurple/conversation/PurpleMessage.java b/android/workspace/im.pidgin.libpurple/src/im/pidgin/libpurple/conversation/PurpleMessage.java
--- a/android/workspace/im.pidgin.libpurple/src/im/pidgin/libpurple/conversation/PurpleMessage.java
+++ b/android/workspace/im.pidgin.libpurple/src/im/pidgin/libpurple/conversation/PurpleMessage.java
@@ -59,7 +59,7 @@ public class PurpleMessage {
 	}
 
 	/**
-	 * Checks whether the message was sent by us.
+	 * Checks whether this message was sent by us.
 	 *
 	 * @return <code>true</code> if and only if the message was sent by us.
 	 */
@@ -68,7 +68,7 @@ public class PurpleMessage {
 	}
 
 	/**
-	 * Checks whether the message was an incoming message
+	 * Checks whether this message was an incoming message
 	 *
 	 * @return <code>true</code> if and only if the message was received.
 	 */
@@ -76,6 +76,12 @@ public class PurpleMessage {
 		return (flags & ConversationConstants.PURPLE_MESSAGE_RECV) != 0;
 	}
 
+	/**
+	 * Checks whether this message was a system message.
+	 *
+	 * @return <code>true</code> if and only if the message was a system
+	 *         message.
+	 */
 	public boolean isSystem() {
 		return (flags & ConversationConstants.PURPLE_MESSAGE_SYSTEM) != 0;
 	}