[telepathy-qt4/master] ReferencedHandles: Moved docs to source file.

Andre Moreira Magalhaes (andrunko) andre.magalhaes at collabora.co.uk
Thu Jun 18 08:26:22 PDT 2009


---
 TelepathyQt4/referenced-handles.cpp |   38 +++++++++++++++++++++++++++++++++++
 TelepathyQt4/referenced-handles.h   |   37 ----------------------------------
 2 files changed, 38 insertions(+), 37 deletions(-)

diff --git a/TelepathyQt4/referenced-handles.cpp b/TelepathyQt4/referenced-handles.cpp
index a727629..5a8ae01 100644
--- a/TelepathyQt4/referenced-handles.cpp
+++ b/TelepathyQt4/referenced-handles.cpp
@@ -28,6 +28,25 @@
 #include <QPointer>
 #include <QSharedData>
 
+/**
+ * \addtogroup clientsideproxies Client-side proxies
+ *
+ * Proxy objects representing remote service objects accessed via D-Bus.
+ *
+ * In addition to providing direct access to methods, signals and properties
+ * exported by the remote objects, some of these proxies offer features like
+ * automatic inspection of remote object capabilities, property tracking,
+ * backwards compatibility helpers for older services and other utilities.
+ */
+
+/**
+ * \defgroup clientconn Connection proxies
+ * \ingroup clientsideproxies
+ *
+ * Proxy objects representing remote Telepathy Connections and their optional
+ * interfaces.
+ */
+
 namespace Tp
 {
 
@@ -94,6 +113,25 @@ private:
     void operator=(const Private&);
 };
 
+/**
+ * \class ReferencedHandles
+ * \ingroup clientconn
+ * \headerfile <TelepathyQt4/referenced-handles.h> <TelepathyQt4/ReferencedHandles>
+ *
+ * Helper container for safe management of handle lifetimes. Every handle in a
+ * ReferencedHandles container is guaranteed to be valid (and stay valid, as
+ * long it's in at least one ReferencedHandles container).
+ *
+ * The class offers a QList-style API. However, from the mutable operations,
+ * only the operations for which the validity guarantees can be preserved are
+ * provided. This means no functions which can add an arbitrary handle to the
+ * container are included - the only way to add handles to the container is to
+ * reference them using Connection::referenceHandles() and appending the
+ * resulting ReferenceHandles instance.
+ *
+ * ReferencedHandles is a implicitly shared class.
+ */
+
 ReferencedHandles::ReferencedHandles()
     : mPriv(new Private)
 {
diff --git a/TelepathyQt4/referenced-handles.h b/TelepathyQt4/referenced-handles.h
index a740bba..9d33346 100644
--- a/TelepathyQt4/referenced-handles.h
+++ b/TelepathyQt4/referenced-handles.h
@@ -26,25 +26,6 @@
 #error IN_TELEPATHY_QT4_HEADER
 #endif
 
-/**
- * \addtogroup clientsideproxies Client-side proxies
- *
- * Proxy objects representing remote service objects accessed via D-Bus.
- *
- * In addition to providing direct access to methods, signals and properties
- * exported by the remote objects, some of these proxies offer features like
- * automatic inspection of remote object capabilities, property tracking,
- * backwards compatibility helpers for older services and other utilities.
- */
-
-/**
- * \defgroup clientconn Connection proxies
- * \ingroup clientsideproxies
- *
- * Proxy objects representing remote Telepathy Connections and their optional
- * interfaces.
- */
-
 #include <TelepathyQt4/Types>
 #include <TelepathyQt4/Types>
 
@@ -62,24 +43,6 @@ namespace Tp
 
 class Connection;
 
-/**
- * \class ReferencedHandles
- * \ingroup clientconn
- * \headerfile <TelepathyQt4/referenced-handles.h> <TelepathyQt4/ReferencedHandles>
- *
- * Helper container for safe management of handle lifetimes. Every handle in a
- * ReferencedHandles container is guaranteed to be valid (and stay valid, as
- * long it's in at least one ReferencedHandles container).
- *
- * The class offers a QList-style API. However, from the mutable operations,
- * only the operations for which the validity guarantees can be preserved are
- * provided. This means no functions which can add an arbitrary handle to the
- * container are included - the only way to add handles to the container is to
- * reference them using Connection::referenceHandles() and appending the
- * resulting ReferenceHandles instance.
- *
- * ReferencedHandles is a implicitly shared class.
- */
 class ReferencedHandles
 {
 public:
-- 
1.5.6.5




More information about the telepathy-commits mailing list