diff options
| author | Guillaume Desmottes <guillaume.desmottes@collabora.co.uk> | 2010-10-11 10:56:39 +0200 |
|---|---|---|
| committer | Guillaume Desmottes <guillaume.desmottes@collabora.co.uk> | 2010-10-11 11:21:56 +0200 |
| commit | e7e082d431f1b9a8592903bb803be570b3528458 (patch) | |
| tree | 0b5638926dab91367a7751a38458b5a15b750fc2 /telepathy-glib/automatic-proxy-factory.c | |
| parent | 91c642269ef5b5c18d82033af0f03d8b72ae7dc8 (diff) | |
| download | telepathy-glib-e7e082d431f1b9a8592903bb803be570b3528458.tar.gz | |
improve TpAutomaticProxyFactory doc
Diffstat (limited to 'telepathy-glib/automatic-proxy-factory.c')
| -rw-r--r-- | telepathy-glib/automatic-proxy-factory.c | 24 |
1 files changed, 19 insertions, 5 deletions
diff --git a/telepathy-glib/automatic-proxy-factory.c b/telepathy-glib/automatic-proxy-factory.c index 0d8cdbab9..ff7b3a870 100644 --- a/telepathy-glib/automatic-proxy-factory.c +++ b/telepathy-glib/automatic-proxy-factory.c @@ -22,15 +22,29 @@ * SECTION:automatic-proxy-factory * @title: TpAutomaticProxyFactory * @short_description: factory creating higher level proxy objects + * @see_also: #TpBasicProxyFactory * * This factory implements the #TpClientChannelFactoryInterface interface to * create specialized #TpChannel subclasses. * - * The current version of #TpAutomaticProxyFactory guarantees to create the - * following objects: - * - if channel is of type TP_IFACE_CHANNEL_TYPE_STREAM_TUBE, a - * #TpStreamTubeChannel - * - for all the other channel types, a #TpChannel + * #TpAutomaticProxyFactory will currently create #TpChannel objects + * as follows: + * + * <itemizedlist> + * <listitem> + * <para>a #TpStreamTubeChannel, if the channel is of type + * %TP_IFACE_CHANNEL_TYPE_STREAM_TUBE;</para> + * </listitem> + * <listitem> + * <para>a plain #TpChannel, otherwise</para> + * </listitem> + * </itemizedlist> + * + * It is guaranteed that the objects returned by future versions + * will be either the class that is currently used, or a more specific + * subclass of that class. + * + * TpProxy subclasses other than TpChannel are not currently supported. */ /** |