aboutsummaryrefslogtreecommitdiff
path: root/src/base
diff options
context:
space:
mode:
authorLinus Jahn <lnj@kaidan.im>2021-04-02 17:27:01 +0200
committerLinus Jahn <lnj@kaidan.im>2021-04-06 15:47:48 +0200
commit93033e9e431e999e9b52dc24cae2170518b685d2 (patch)
tree868836664e97b825e242aeaa56e9254d1ae14109 /src/base
parentd8dbd2b963adf4774ca600fca729bf9ae1a41fef (diff)
downloadqxmpp-93033e9e431e999e9b52dc24cae2170518b685d2.tar.gz
doc: Fix warnings from QXmppMam{Query,Result}Iq
Diffstat (limited to 'src/base')
-rw-r--r--src/base/QXmppMamIq.cpp50
-rw-r--r--src/base/QXmppMamIq.h20
2 files changed, 54 insertions, 16 deletions
diff --git a/src/base/QXmppMamIq.cpp b/src/base/QXmppMamIq.cpp
index 331d36d0..c62d0c68 100644
--- a/src/base/QXmppMamIq.cpp
+++ b/src/base/QXmppMamIq.cpp
@@ -36,69 +36,98 @@ public:
QString queryId;
};
+///
+/// \class QXmppMamQueryIq
+///
+/// The QXmppMamQueryIq class represents the query IQ for \xep{0313, Message
+/// Archive Management}.
+///
+/// \ingroup Stanzas
+///
+/// \since QXmpp 1.0
+///
+
QXmppMamQueryIq::QXmppMamQueryIq()
: QXmppIq(QXmppIq::Set),
d(new QXmppMamQueryIqPrivate)
{
}
+/// Default copy constructor
QXmppMamQueryIq::QXmppMamQueryIq(const QXmppMamQueryIq &) = default;
QXmppMamQueryIq::~QXmppMamQueryIq() = default;
+/// Default assignemnt operator
QXmppMamQueryIq &QXmppMamQueryIq::operator=(const QXmppMamQueryIq &) = default;
+///
/// Returns the form that specifies the query.
+///
QXmppDataForm QXmppMamQueryIq::form() const
{
return d->form;
}
+///
/// Sets the data form that specifies the query.
///
/// \param form The data form.
+///
void QXmppMamQueryIq::setForm(const QXmppDataForm &form)
{
d->form = form;
}
+///
/// Returns the result set query for result set management.
+///
QXmppResultSetQuery QXmppMamQueryIq::resultSetQuery() const
{
return d->resultSetQuery;
}
+///
/// Sets the result set query for result set management.
///
/// \param resultSetQuery The result set query.
+///
void QXmppMamQueryIq::setResultSetQuery(const QXmppResultSetQuery &resultSetQuery)
{
d->resultSetQuery = resultSetQuery;
}
+///
/// Returns the node to query.
+///
QString QXmppMamQueryIq::node() const
{
return d->node;
}
+///
/// Sets the node to query.
///
/// \param node The node to query.
+///
void QXmppMamQueryIq::setNode(const QString &node)
{
d->node = node;
}
+///
/// Returns the queryid that will be included in the results.
+///
QString QXmppMamQueryIq::queryId() const
{
return d->queryId;
}
+///
/// Sets the queryid that will be included in the results.
///
/// \param id The query id.
+///
void QXmppMamQueryIq::setQueryId(const QString &id)
{
d->queryId = id;
@@ -154,39 +183,60 @@ public:
bool complete;
};
+///
+/// \class QXmppMamQueryIq
+///
+/// The QXmppMamQueryIq class represents the result IQ for \xep{0313, Message
+/// Archive Management}.
+///
+/// \ingroup Stanzas
+///
+/// \since QXmpp 1.0
+///
+
QXmppMamResultIq::QXmppMamResultIq()
: d(new QXmppMamResultIqPrivate)
{
d->complete = false;
}
+/// Default copy constructor
QXmppMamResultIq::QXmppMamResultIq(const QXmppMamResultIq &) = default;
QXmppMamResultIq::~QXmppMamResultIq() = default;
+/// Default assignemnt operator
QXmppMamResultIq &QXmppMamResultIq::operator=(const QXmppMamResultIq &) = default;
+///
/// Returns the result set reply for result set management.
+///
QXmppResultSetReply QXmppMamResultIq::resultSetReply() const
{
return d->resultSetReply;
}
+///
/// Sets the result set reply for result set management
+///
void QXmppMamResultIq::setResultSetReply(const QXmppResultSetReply &resultSetReply)
{
d->resultSetReply = resultSetReply;
}
+///
/// Returns true if the results returned by the server are complete (not
/// limited by the server).
+///
bool QXmppMamResultIq::complete() const
{
return d->complete;
}
+///
/// Sets if the results returned by the server are complete (not limited by the
/// server).
+///
void QXmppMamResultIq::setComplete(bool complete)
{
d->complete = complete;
diff --git a/src/base/QXmppMamIq.h b/src/base/QXmppMamIq.h
index d23caa97..e1f795f3 100644
--- a/src/base/QXmppMamIq.h
+++ b/src/base/QXmppMamIq.h
@@ -33,14 +33,6 @@
class QXmppMamQueryIqPrivate;
class QXmppMamResultIqPrivate;
-///
-/// \brief The QXmppMamQueryIq class represents the query IQ for
-/// \xep{0313}: Message Archive Management.
-///
-/// \ingroup Stanzas
-///
-/// \since QXmpp 1.0
-///
class QXmppMamQueryIq : public QXmppIq
{
public:
@@ -59,24 +51,18 @@ public:
QString queryId() const;
void setQueryId(const QString &id);
+ /// \cond
static bool isMamQueryIq(const QDomElement &element);
protected:
void parseElementFromChild(const QDomElement &element) override;
void toXmlElementFromChild(QXmlStreamWriter *writer) const override;
+ /// \endcond
private:
QSharedDataPointer<QXmppMamQueryIqPrivate> d;
};
-///
-/// \brief The QXmppMamQueryIq class represents the result IQ for
-/// \xep{0313}: Message Archive Management.
-///
-/// \ingroup Stanzas
-///
-/// \since QXmpp 1.0
-///
class QXmppMamResultIq : public QXmppIq
{
public:
@@ -91,11 +77,13 @@ public:
bool complete() const;
void setComplete(bool complete);
+ /// \cond
static bool isMamResultIq(const QDomElement &element);
protected:
void parseElementFromChild(const QDomElement &element) override;
void toXmlElementFromChild(QXmlStreamWriter *writer) const override;
+ /// \endcond
private:
QSharedDataPointer<QXmppMamResultIqPrivate> d;