telepathy-qt: Fixed various documentation issues.
Alexandr Akulich
kaffeine at kemper.freedesktop.org
Wed May 6 01:10:28 PDT 2015
Module: telepathy-qt
Branch: master
Commit: 211b62de518c21e38b3a9cf3735b30fb5a43d884
URL: http://cgit.freedesktop.org/telepathy/telepathy-qt/commit/?id=211b62de518c21e38b3a9cf3735b30fb5a43d884
Author: Alexandr Akulich <akulichalexander at gmail.com>
Date: Thu Apr 23 17:32:26 2015 +0500
Fixed various documentation issues.
Reviewed-by: David Edmundson
---
TelepathyQt/abstract-client.cpp | 5 -----
TelepathyQt/account.cpp | 2 +-
TelepathyQt/channel-request.cpp | 1 +
TelepathyQt/connection-manager.cpp | 3 +++
TelepathyQt/contact.cpp | 7 ++++---
TelepathyQt/outgoing-stream-tube-channel.cpp | 2 +-
TelepathyQt/profile.cpp | 2 +-
TelepathyQt/text-channel.cpp | 2 +-
8 files changed, 12 insertions(+), 12 deletions(-)
diff --git a/TelepathyQt/abstract-client.cpp b/TelepathyQt/abstract-client.cpp
index b504bd0..d504d45 100644
--- a/TelepathyQt/abstract-client.cpp
+++ b/TelepathyQt/abstract-client.cpp
@@ -906,11 +906,6 @@ AbstractClientHandler::Capabilities AbstractClientHandler::handlerCapabilities()
* \param account The account with which the channels are associated.
* \param connection The connection with which the channels are associated.
* \param channels The channels to be handled.
- * \param dispatchOperation The dispatch operation for these channels.
- * The object will be invalid (DBusProxy::isValid()
- * will be false) if there is no dispatch
- * operation in place (because the channels were
- * requested, not incoming).
* \param requestsSatisfied The requests satisfied by these channels.
* \param userActionTime The time at which user action occurred, or 0 if this
* channel is to be handled for some reason not involving
diff --git a/TelepathyQt/account.cpp b/TelepathyQt/account.cpp
index 8247a30..8d4c7a7 100644
--- a/TelepathyQt/account.cpp
+++ b/TelepathyQt/account.cpp
@@ -3859,7 +3859,7 @@ PendingChannel *Account::createAndHandleDBusTube(
* which can be used to track the success or failure of the request.
*
* \param contact The contact to open a DBus tube with.
- * \param service The DBus tube service name.
+ * \param serviceName The DBus tube service name.
* \param userActionTime The time at which user action occurred, or QDateTime()
* if this channel request is for some reason not
* involving user action.
diff --git a/TelepathyQt/channel-request.cpp b/TelepathyQt/channel-request.cpp
index 3b13863..ec94553 100644
--- a/TelepathyQt/channel-request.cpp
+++ b/TelepathyQt/channel-request.cpp
@@ -286,6 +286,7 @@ const Feature ChannelRequest::FeatureCore = Feature(QLatin1String(ChannelRequest
/**
* Create a new channel request object using the given \a bus and the given factories.
*
+ * \param bus QDBusConnection to use.
* \param objectPath The channel request object path.
* \param immutableProperties The channel request immutable properties.
* \param accountFactory The account factory to use.
diff --git a/TelepathyQt/connection-manager.cpp b/TelepathyQt/connection-manager.cpp
index e6e32e0..5b7d203 100644
--- a/TelepathyQt/connection-manager.cpp
+++ b/TelepathyQt/connection-manager.cpp
@@ -769,6 +769,9 @@ ConnectionManagerPtr ConnectionManager::create(const QDBusConnection &bus,
*
* \param bus QDBusConnection to use.
* \param name Name of the connection manager.
+ * \param connectionFactory The connection factory to use.
+ * \param channelFactory The channel factory to use.
+ * \param contactFactory The contact factory to use.
*/
ConnectionManager::ConnectionManager(const QDBusConnection &bus,
const QString &name,
diff --git a/TelepathyQt/contact.cpp b/TelepathyQt/contact.cpp
index 8f28061..d244d64 100644
--- a/TelepathyQt/contact.cpp
+++ b/TelepathyQt/contact.cpp
@@ -1371,7 +1371,7 @@ void Contact::setRemovedFromGroup(const QString &group)
*
* Emitted when the value of location() changes.
*
- * \param caps The new location of this contact.
+ * \param location The new location of this contact.
* \sa location()
*/
@@ -1380,7 +1380,7 @@ void Contact::setRemovedFromGroup(const QString &group)
*
* Emitted when the value of infoFields() changes.
*
- * \param InfoFields The new info of this contact.
+ * \param infoFields The new info of this contact.
* \sa infoFields()
*/
@@ -1399,6 +1399,7 @@ void Contact::setRemovedFromGroup(const QString &group)
* Emitted when the value of publishState() changes.
*
* \param state The new publish state of this contact.
+ * \param message The new user-defined status message of this contact.
* \sa publishState()
*/
@@ -1407,7 +1408,7 @@ void Contact::setRemovedFromGroup(const QString &group)
*
* Emitted when the value of isBlocked() changes.
*
- * \param status The new block status of this contact.
+ * \param blocked The new block status of this contact.
* \sa isBlocked()
*/
diff --git a/TelepathyQt/outgoing-stream-tube-channel.cpp b/TelepathyQt/outgoing-stream-tube-channel.cpp
index 64e7c2f..7dee397 100644
--- a/TelepathyQt/outgoing-stream-tube-channel.cpp
+++ b/TelepathyQt/outgoing-stream-tube-channel.cpp
@@ -465,7 +465,7 @@ PendingOperation *OutgoingStreamTubeChannel::offerTcpSocket(
*
* This method requires OutgoingStreamTubeChannel::FeatureCore to be ready.
*
- * \param address A valid path to an existing Unix socket or abstract Unix socket.
+ * \param socketAddress A valid path to an existing Unix socket or abstract Unix socket.
* \param parameters A dictionary of arbitrary parameters to send with the tube offer.
* \param requireCredentials Whether the server requires a SCM_CREDS or SCM_CREDENTIALS message
* upon connection.
diff --git a/TelepathyQt/profile.cpp b/TelepathyQt/profile.cpp
index a67800f..2fd8f64 100644
--- a/TelepathyQt/profile.cpp
+++ b/TelepathyQt/profile.cpp
@@ -527,7 +527,7 @@ void Profile::Private::invalidate()
* \brief The Profile class provides an easy way to read Telepathy profile
* files according to http://telepathy.freedesktop.org/wiki/service-profile-v1.
*
- * Note that profiles with xml element <type> different than "IM" are considered
+ * Note that profiles with xml element \<type\> different than "IM" are considered
* invalid.
*/
diff --git a/TelepathyQt/text-channel.cpp b/TelepathyQt/text-channel.cpp
index a043e4c..28a1a2d 100644
--- a/TelepathyQt/text-channel.cpp
+++ b/TelepathyQt/text-channel.cpp
@@ -999,7 +999,7 @@ PendingSendMessage *TextChannel::send(const QString &text,
*
* This method requires TextChannel::FeatureCore to be ready.
*
- * \param part The message parts.
+ * \param parts The message parts.
* \param flags Flags affecting how the message is sent.
* Note that the channel may ignore some or all flags, depending on
* deliveryReportingSupport(); the flags that were handled by the CM are provided in
More information about the telepathy-commits
mailing list