diff options
author | Andre Moreira Magalhaes (andrunko) <andre.magalhaes@collabora.co.uk> | 2011-07-15 17:05:38 -0300 |
---|---|---|
committer | Andre Moreira Magalhaes (andrunko) <andre.magalhaes@collabora.co.uk> | 2011-07-15 17:50:39 -0300 |
commit | e1eee6779e6d0830ef4df911b004b4ceace2af52 (patch) | |
tree | 7b788f49d25daf3d3ddaa58f0efbb9d7d3d07994 /qt4 | |
parent | 7e5fbfe485c42f499b4a8e52d96429ad95ffe18e (diff) |
ContactSearchChannel: Update docs.
Diffstat (limited to 'qt4')
-rw-r--r-- | qt4/TelepathyQt4/contact-search-channel.cpp | 28 |
1 files changed, 14 insertions, 14 deletions
diff --git a/qt4/TelepathyQt4/contact-search-channel.cpp b/qt4/TelepathyQt4/contact-search-channel.cpp index 2638fe45a..ba7c361aa 100644 --- a/qt4/TelepathyQt4/contact-search-channel.cpp +++ b/qt4/TelepathyQt4/contact-search-channel.cpp @@ -346,8 +346,8 @@ const Feature ContactSearchChannel::FeatureCore = Feature(QLatin1String(ContactS * * \param connection Connection owning this channel, and specifying the * service. - * \param objectPath The object path of this channel. - * \param immutableProperties The immutable properties of this channel. + * \param objectPath The channel object path. + * \param immutableProperties The channel immutable properties. * \return A ContactSearchChannelPtr object pointing to the newly created * ContactSearchChannel object. */ @@ -359,14 +359,14 @@ ContactSearchChannelPtr ContactSearchChannel::create(const ConnectionPtr &connec } /** - * Construct a new contact search channel associated with the given \a objectPath - * on the same service as the given \a connection. - * - * \param connection Connection owning this channel, and specifying the service. - * \param objectPath Path to the object on the service. - * \param immutableProperties The immutable properties of the channel. - * \param coreFeature The core feature of the channel type. The corresponding introspectable should - * depend on ContactSearchChannel::FeatureCore. + * Construct a new ContactSearchChannel object. + * + * \param connection Connection owning this channel, and specifying the + * service. + * \param objectPath The channel object path. + * \param immutableProperties The channel immutable properties. + * \param coreFeature The core feature of the channel type, if any. The corresponding introspectable should + * depend on ContactSearchChannel::FeatureCore. */ ContactSearchChannel::ContactSearchChannel(const ConnectionPtr &connection, const QString &objectPath, @@ -451,9 +451,9 @@ QString ContactSearchChannel::server() const /** * Send a request to start a search for contacts on this connection. * - * This may only be called while the searchState() is ChannelContactSearchStateNotStarted; + * This may only be called while the searchState() is #ChannelContactSearchStateNotStarted; * a valid search request will cause the searchStateChanged() signal to be emitted with the - * state ChannelContactSearchStateInProgress. + * state #ChannelContactSearchStateInProgress. * * Search results are signalled by searchResultReceived(). * @@ -477,9 +477,9 @@ PendingOperation *ContactSearchChannel::search(const QString &searchKey, const Q /** * Send a request to start a search for contacts on this connection. * - * This may only be called while the searchState() is ChannelContactSearchStateNotStarted; + * This may only be called while the searchState() is #ChannelContactSearchStateNotStarted; * a valid search request will cause the searchStateChanged() signal to be emitted with the - * state ChannelContactSearchStateInProgress. + * state #ChannelContactSearchStateInProgress. * * Search results are signalled by searchResultReceived(). * |