From 66a47b836701ff76fe1adb4a02e72bee48db9b1b Mon Sep 17 00:00:00 2001
From: Matt Tucker <matt@jivesoftware.com>
Date: Fri, 15 Aug 2003 19:36:20 +0000
Subject: [PATCH] Javadoc improvements.

git-svn-id: http://svn.igniterealtime.org/svn/repos/smack/trunk@2027 b35dd754-fafc-0310-a699-88a17e54d16e
---
 source/org/jivesoftware/smack/packet/IQ.java | 14 +++++++++++---
 1 file changed, 11 insertions(+), 3 deletions(-)

diff --git a/source/org/jivesoftware/smack/packet/IQ.java b/source/org/jivesoftware/smack/packet/IQ.java
index ab93f46e8..3c79633d1 100644
--- a/source/org/jivesoftware/smack/packet/IQ.java
+++ b/source/org/jivesoftware/smack/packet/IQ.java
@@ -53,11 +53,19 @@
 package org.jivesoftware.smack.packet;
 
 /**
- * A generic IQ (Info/Query) packet. IQ packets are used to get and set information
+ * The base IQ (Info/Query) packet. IQ packets are used to get and set information
  * on the server, including authentication, roster operations, and creating
  * accounts. Each IQ packet has a specific type that indicates what type of action
- * is being taken: "get", "set", "result", or "error". The actual data of an IQ
- * packet is normally enclosed in the query section with a specific namespace.
+ * is being taken: "get", "set", "result", or "error".<p>
+ *
+ * IQ packets can contain a single child element that exists in a specific XML
+ * namespace. The combination of the element name and namespace determines what
+ * type of IQ packet it is. Some example IQ subpacket snippets:<ul>
+ *
+ *  <li>&lt;query xmlns="jabber:iq:auth"&gt; -- an authentication IQ.
+ *  <li>&lt;query xmlns="jabber:iq:private"&gt; -- a private storage IQ.
+ *  <li>&lt;pubsub xmlns="http://jabber.org/protocol/pubsub"&gt; -- a pubsub IQ.
+ * </ul>
  *
  * @author Matt Tucker
  */