aboutsummaryrefslogtreecommitdiff
path: root/src
diff options
context:
space:
mode:
authorLinus Jahn <lnj@kaidan.im>2019-10-21 19:24:50 +0200
committerLinus Jahn <lnj@kaidan.im>2019-10-21 19:24:50 +0200
commit70dfa23900a3905285435a10fdaa97462a67016f (patch)
tree676f4fb9f2b47c353cc1dfc3c496a481bc3c21c7 /src
parent4af8f27d6bcbb44d349f4637d4653ac6ca3de09c (diff)
downloadqxmpp-70dfa23900a3905285435a10fdaa97462a67016f.tar.gz
QXmppUploadRequestManager: Fix doxygen warnings
Diffstat (limited to 'src')
-rw-r--r--src/client/QXmppUploadRequestManager.cpp6
-rw-r--r--src/client/QXmppUploadRequestManager.h14
2 files changed, 11 insertions, 9 deletions
diff --git a/src/client/QXmppUploadRequestManager.cpp b/src/client/QXmppUploadRequestManager.cpp
index 09268637..08a0da0d 100644
--- a/src/client/QXmppUploadRequestManager.cpp
+++ b/src/client/QXmppUploadRequestManager.cpp
@@ -45,10 +45,14 @@ QXmppUploadService::QXmppUploadService()
{
}
+/// Copy constructor
+
QXmppUploadService::QXmppUploadService(const QXmppUploadService &) = default;
QXmppUploadService::~QXmppUploadService() = default;
+/// Equal operator
+
QXmppUploadService &QXmppUploadService::operator=(const QXmppUploadService &) = default;
/// Returns the JID of the HTTP File Upload service.
@@ -171,7 +175,7 @@ QString QXmppUploadRequestManager::requestUploadSlot(const QString &fileName,
return {};
}
-/// Returns true, if an HTTP File Upload service has been discovered.
+/// Returns true if an HTTP File Upload service has been discovered.
bool QXmppUploadRequestManager::serviceFound() const
{
diff --git a/src/client/QXmppUploadRequestManager.h b/src/client/QXmppUploadRequestManager.h
index d83130f7..7fc7e653 100644
--- a/src/client/QXmppUploadRequestManager.h
+++ b/src/client/QXmppUploadRequestManager.h
@@ -34,10 +34,9 @@ class QXmppHttpUploadSlotIq;
class QXmppUploadServicePrivate;
class QXmppUploadRequestManagerPrivate;
-/// \class QXmppUploadService The QXmppUploadService represents an HTTP File
-/// Upload service.
+/// \brief QXmppUploadService represents an HTTP File Upload service.
///
-/// It is only used to store the JID and maximum file size for uploads.
+/// It is used to store the JID and maximum file size for uploads.
class QXMPP_EXPORT QXmppUploadService
{
@@ -58,8 +57,8 @@ private:
QSharedDataPointer<QXmppUploadServicePrivate> d;
};
-/// \class QXmppUploadRequestManager This class implements the core of
-/// XEP-0369: HTTP File Upload.
+/// \brief The QXmppUploadRequestManager implements the core of XEP-0369: HTTP
+/// File Upload.
///
/// It handles the discovery of QXmppUploadServices and can send upload
/// requests and outputs the upload slots. It doesn't do the actual upload via.
@@ -94,7 +93,6 @@ private:
class QXMPP_EXPORT QXmppUploadRequestManager : public QXmppClientExtension
{
Q_OBJECT
- Q_PROPERTY(bool serviceFound READ serviceFound NOTIFY serviceFoundChanged)
public:
QXmppUploadRequestManager();
@@ -122,10 +120,10 @@ signals:
/// Emitted when the slot request failed.
///
- /// You can get the reason from the QXmppStanza::Error of the returned
- /// request.
+ /// \param request The sent IQ with an QXmppStanza::Error from the server.
void requestFailed(const QXmppHttpUploadRequestIq &request);
+ /// Emitted when the first upload service has been found.
void serviceFoundChanged();
protected: