[Telepathy-commits] [telepathy-glib/master] Document TpExportableChannel

[Will Thompson]

---
 docs/reference/telepathy-glib-sections.txt |   15 +++++++++++++++
 telepathy-glib/exportable-channel.c        |   12 ++++++++++++
 telepathy-glib/exportable-channel.h        |   20 ++++++++++++++++++++
 3 files changed, 47 insertions(+), 0 deletions(-)

diff --git a/docs/reference/telepathy-glib-sections.txt b/docs/reference/telepathy-glib-sections.txt
index 68f5048..0a97f4b 100644
--- a/docs/reference/telepathy-glib-sections.txt
+++ b/docs/reference/telepathy-glib-sections.txt
@@ -109,6 +109,21 @@ TP_CHANNEL_FACTORY_IFACE_GET_CLASS
 </SECTION>
 
 <SECTION>
+<INCLUDE>telepathy-glib/exportable-channel.h</INCLUDE>
+<FILE>exportable-channel</FILE>
+TpExportableChannelFunc
+<TITLE>TpExportableChannel</TITLE>
+TpExportableChannel
+TpExportableChannelIface
+<SUBSECTION Standard>
+TP_EXPORTABLE_CHANNEL
+TP_IS_EXPORTABLE_CHANNEL
+TP_TYPE_EXPORTABLE_CHANNEL
+tp_exportable_channel_get_type
+TP_EXPORTABLE_CHANNEL_GET_INTERFACE
+</SECTION>
+
+<SECTION>
 <FILE>handle-repo</FILE>
 <INCLUDE>telepathy-glib/handle-repo.h</INCLUDE>
 <TITLE>handle-repo</TITLE>
diff --git a/telepathy-glib/exportable-channel.c b/telepathy-glib/exportable-channel.c
index fa2da00..c189662 100644
--- a/telepathy-glib/exportable-channel.c
+++ b/telepathy-glib/exportable-channel.c
@@ -19,6 +19,18 @@
  * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA  02110-1301  USA
  */
 
+/**
+ * SECTION:exportable-channel
+ * @title: TpExportableChannel
+ * @short_description: interface representing channels with several standard
+ *                     properties
+ * @see_also: #TpChannelIface, #TpChannelManager, #TpSvcChannel
+ *
+ * This interface defines a set of channel properties on top of those of
+ * #TpChannelIface. It's mainly used by #TpChannelManager to represent the
+ * returned and managed channel objects.
+ */
+
 #include "config.h"
 #include "exportable-channel.h"
 
diff --git a/telepathy-glib/exportable-channel.h b/telepathy-glib/exportable-channel.h
index 978813e..194aec4 100644
--- a/telepathy-glib/exportable-channel.h
+++ b/telepathy-glib/exportable-channel.h
@@ -40,12 +40,32 @@ G_BEGIN_DECLS
   (G_TYPE_INSTANCE_GET_INTERFACE ((obj), \
   TP_TYPE_EXPORTABLE_CHANNEL, TpExportableChannelIface))
 
+/**
+ * TpExportableChannel:
+ *
+ * Opaque typedef representing a channel with several standard properties.
+ */
 typedef struct _TpExportableChannel TpExportableChannel;
+
 typedef struct _TpExportableChannelIface TpExportableChannelIface;
 
+
+/**
+ * TpExportableChannelFunc:
+ * @channel: An object implementing the exportable channel interface
+ * @user_data: Arbitrary user-supplied data
+ *
+ * A callback for functions which act on exportable channels.
+ */
 typedef void (*TpExportableChannelFunc) (TpExportableChannel *channel,
     gpointer user_data);
 
+/**
+ * TpExportableChannelIface:
+ * @parent: The parent interface
+ *
+ * The interface for #TpExportableChannel objects.
+ */
 struct _TpExportableChannelIface {
     GTypeInterface parent;
 };
-- 
1.5.6.5