summaryrefslogtreecommitdiff
path: root/qpid/cpp/lib/common/framing/FieldTable.h
diff options
context:
space:
mode:
authorGordon Sim <gsim@apache.org>2006-12-13 17:15:01 +0000
committerGordon Sim <gsim@apache.org>2006-12-13 17:15:01 +0000
commit036527ef6d2460d13b29857f34a0e0c91814246a (patch)
treef6e9ba4d794368d5fbfb1bf66db14ba60908532b /qpid/cpp/lib/common/framing/FieldTable.h
parent2b03d1a8dce5bc9d7d6baa19497554764f03721b (diff)
downloadqpid-python-036527ef6d2460d13b29857f34a0e0c91814246a.tar.gz
Added some doxygen comments for the client API.
git-svn-id: https://svn.apache.org/repos/asf/incubator/qpid/trunk@486747 13f79535-47bb-0310-9956-ffa450edef68
Diffstat (limited to 'qpid/cpp/lib/common/framing/FieldTable.h')
-rw-r--r--qpid/cpp/lib/common/framing/FieldTable.h10
1 files changed, 10 insertions, 0 deletions
diff --git a/qpid/cpp/lib/common/framing/FieldTable.h b/qpid/cpp/lib/common/framing/FieldTable.h
index 3d09cdec64..6fa10ab108 100644
--- a/qpid/cpp/lib/common/framing/FieldTable.h
+++ b/qpid/cpp/lib/common/framing/FieldTable.h
@@ -28,11 +28,21 @@
#define _FieldTable_
namespace qpid {
+ /**
+ * The framing namespace contains classes that are used to create,
+ * send and receive the basic packets from which AMQP is built.
+ */
namespace framing {
class Value;
class Buffer;
+/**
+ * A set of name-value pairs. (See the AMQP spec for more details on
+ * AMQP field tables).
+ *
+ * \ingroup clientapi
+ */
class FieldTable
{
public: