From e722018808941ae7413f4ce6ac4a94ef77c41dbd Mon Sep 17 00:00:00 2001 From: Florian Schmaus Date: Wed, 21 Jan 2015 23:48:46 +0100 Subject: [PATCH] Improve IQ.Type javadoc --- .../org/jivesoftware/smack/packet/IQ.java | 27 ++++++++++++------- 1 file changed, 18 insertions(+), 9 deletions(-) diff --git a/smack-core/src/main/java/org/jivesoftware/smack/packet/IQ.java b/smack-core/src/main/java/org/jivesoftware/smack/packet/IQ.java index 1dacac6a2..60e2e4587 100644 --- a/smack-core/src/main/java/org/jivesoftware/smack/packet/IQ.java +++ b/smack-core/src/main/java/org/jivesoftware/smack/packet/IQ.java @@ -256,21 +256,30 @@ public abstract class IQ extends Packet { } /** - * A enum to represent the type of the IQ packet. The types are: - * - * + * A enum to represent the type of the IQ stanza. */ public enum Type { + /** + * The IQ stanza requests information, inquires about what data is needed in order to complete further operations, etc. + */ get, + + /** + * The IQ stanza provides data that is needed for an operation to be completed, sets new values, replaces existing values, etc. + */ set, + + /** + * The IQ stanza is a response to a successful get or set request. + */ result, - error; + + /** + * The IQ stanza reports an error that has occurred regarding processing or delivery of a get or set request. + */ + error, + ; /** * Converts a String into the corresponding types. Valid String values