diff options
| author | Pekka Vuorela <pvuorela@iki.fi> | 2025-12-11 09:53:10 +0200 |
|---|---|---|
| committer | Pekka Vuorela <pvuorela@iki.fi> | 2025-12-11 11:11:18 +0200 |
| commit | 73553fb423497c561392e32432f9f0a82b0afb09 (patch) | |
| tree | f3768fd4571916e08459dfd43223fa45ecb4a618 | |
| parent | 45822c8f2b828d3d1ff2ebcab06f7a3c2b46a73a (diff) | |
Mark serialize() methods \internal
Qdoc is having trouble with the templates and was unable to find
content for any of these, instead just complaining. Besides that we
don't really even want to promote this functionality and hopefully
would get rid of it.
Also QMailKeyArgument::ValueList::operator==() documentation didn't
work. Just removed that as minor detail.
Change-Id: I1956c19cf53ed7ef93478d629755b39fbfdbd4bd
Reviewed-by: <matti.viljanen@kapsi.fi>
Reviewed-by: Damien Caliste <dcaliste@free.fr>
Reviewed-by: Pekka Vuorela <pvuorela@iki.fi>
| -rw-r--r-- | src/libraries/qmfclient/qmailaccountkey.cpp | 2 | ||||
| -rw-r--r-- | src/libraries/qmfclient/qmailaccountsortkey.cpp | 2 | ||||
| -rw-r--r-- | src/libraries/qmfclient/qmailfolderkey.cpp | 2 | ||||
| -rw-r--r-- | src/libraries/qmfclient/qmailfoldersortkey.cpp | 2 | ||||
| -rw-r--r-- | src/libraries/qmfclient/qmailkeyargument.cpp | 10 | ||||
| -rw-r--r-- | src/libraries/qmfclient/qmailmessagekey.cpp | 4 | ||||
| -rw-r--r-- | src/libraries/qmfclient/qmailmessagesortkey.cpp | 2 | ||||
| -rw-r--r-- | src/libraries/qmfclient/qmailthreadkey.cpp | 2 | ||||
| -rw-r--r-- | src/libraries/qmfclient/qmailthreadsortkey.cpp | 3 |
9 files changed, 22 insertions, 7 deletions
diff --git a/src/libraries/qmfclient/qmailaccountkey.cpp b/src/libraries/qmfclient/qmailaccountkey.cpp index 201133cd..7f139e04 100644 --- a/src/libraries/qmfclient/qmailaccountkey.cpp +++ b/src/libraries/qmfclient/qmailaccountkey.cpp @@ -300,6 +300,7 @@ QMailKey::Combiner QMailAccountKey::combiner() const /*! \fn QMailAccountKey::serialize(Stream &stream) const + \internal Writes the contents of a QMailAccountKey to a \a stream. */ @@ -310,6 +311,7 @@ template <typename Stream> void QMailAccountKey::serialize(Stream &stream) const /*! \fn QMailAccountKey::deserialize(Stream &stream) + \internal Reads the contents of a QMailAccountKey from \a stream. */ diff --git a/src/libraries/qmfclient/qmailaccountsortkey.cpp b/src/libraries/qmfclient/qmailaccountsortkey.cpp index 709c8cbc..bdcdf510 100644 --- a/src/libraries/qmfclient/qmailaccountsortkey.cpp +++ b/src/libraries/qmfclient/qmailaccountsortkey.cpp @@ -181,6 +181,7 @@ const QList<QMailAccountSortKey::ArgumentType> &QMailAccountSortKey::arguments() /*! \fn QMailAccountSortKey::serialize(Stream &stream) const + \internal Writes the contents of a QMailAccountSortKey to a \a stream. */ @@ -191,6 +192,7 @@ template <typename Stream> void QMailAccountSortKey::serialize(Stream &stream) c /*! \fn QMailAccountSortKey::deserialize(Stream &stream) + \internal Reads the contents of a QMailAccountSortKey from \a stream. */ diff --git a/src/libraries/qmfclient/qmailfolderkey.cpp b/src/libraries/qmfclient/qmailfolderkey.cpp index 0e586f43..8947b3bb 100644 --- a/src/libraries/qmfclient/qmailfolderkey.cpp +++ b/src/libraries/qmfclient/qmailfolderkey.cpp @@ -308,6 +308,7 @@ QMailKey::Combiner QMailFolderKey::combiner() const /*! \fn QMailFolderKey::serialize(Stream &stream) const + \internal Writes the contents of a QMailFolderKey to a \a stream. */ @@ -318,6 +319,7 @@ template <typename Stream> void QMailFolderKey::serialize(Stream &stream) const /*! \fn QMailFolderKey::deserialize(Stream &stream) + \internal Reads the contents of a QMailFolderKey from \a stream. */ diff --git a/src/libraries/qmfclient/qmailfoldersortkey.cpp b/src/libraries/qmfclient/qmailfoldersortkey.cpp index a2c72144..a5ee8807 100644 --- a/src/libraries/qmfclient/qmailfoldersortkey.cpp +++ b/src/libraries/qmfclient/qmailfoldersortkey.cpp @@ -185,6 +185,7 @@ const QList<QMailFolderSortKey::ArgumentType> &QMailFolderSortKey::arguments() c /*! \fn QMailFolderSortKey::serialize(Stream &stream) const + \internal Writes the contents of a QMailFolderSortKey to a \a stream. */ @@ -195,6 +196,7 @@ template <typename Stream> void QMailFolderSortKey::serialize(Stream &stream) co /*! \fn QMailFolderSortKey::deserialize(Stream &stream) + \internal Reads the contents of a QMailFolderSortKey from \a stream. */ diff --git a/src/libraries/qmfclient/qmailkeyargument.cpp b/src/libraries/qmfclient/qmailkeyargument.cpp index a7de5270..86b13e17 100644 --- a/src/libraries/qmfclient/qmailkeyargument.cpp +++ b/src/libraries/qmfclient/qmailkeyargument.cpp @@ -95,19 +95,15 @@ */ /*! - \fn bool QMailKeyArgument::ValueList::operator==(const ValueList &other) const - - Returns true if this list and \a other contain equivalent values. -*/ - -/*! \fn void QMailKeyArgument::ValueList::serialize(Stream &stream) const + \internal Writes the contents of a ValueList to \a stream. */ /*! \fn void QMailKeyArgument::ValueList::deserialize(Stream &stream) + \internal Reads the contents of a ValueList from \a stream. */ @@ -131,12 +127,14 @@ /*! \fn void QMailKeyArgument::serialize(Stream &stream) const + \internal Writes the contents of a QMailKeyArgument to \a stream. */ /*! \fn void QMailKeyArgument::deserialize(Stream &stream) + \internal Reads the contents of a QMailKeyArgument from \a stream. */ diff --git a/src/libraries/qmfclient/qmailmessagekey.cpp b/src/libraries/qmfclient/qmailmessagekey.cpp index 92b6c200..f3bf1997 100644 --- a/src/libraries/qmfclient/qmailmessagekey.cpp +++ b/src/libraries/qmfclient/qmailmessagekey.cpp @@ -328,6 +328,7 @@ QMailKey::Combiner QMailMessageKey::combiner() const /*! \fn QMailMessageKey::serialize(Stream &stream) const + \internal Writes the contents of a QMailMessageKey to a \a stream. */ @@ -338,6 +339,7 @@ template <typename Stream> void QMailMessageKey::serialize(Stream &stream) const /*! \fn QMailMessageKey::deserialize(Stream &stream) + \internal Reads the contents of a QMailMessageKey from \a stream. */ @@ -1093,12 +1095,14 @@ QMailMessageKey QMailMessageKey::parentThreadId(const QMailThreadKey &key, QMail //create implementations for QDataStream /*! \fn void QMailMessageKey::serialize<QDataStream>(QDataStream& stream) const; + \internal Serialize the message key to \a stream. */ template void QMF_EXPORT QMailMessageKey::serialize<QDataStream>(QDataStream& stream) const; /*! \fn void QMailMessageKey::deserialize<QDataStream>(QDataStream& stream); + \internal Deserialize the message key from \a stream. */ template void QMF_EXPORT QMailMessageKey::deserialize<QDataStream>(QDataStream& stream); diff --git a/src/libraries/qmfclient/qmailmessagesortkey.cpp b/src/libraries/qmfclient/qmailmessagesortkey.cpp index a58289ed..24933806 100644 --- a/src/libraries/qmfclient/qmailmessagesortkey.cpp +++ b/src/libraries/qmfclient/qmailmessagesortkey.cpp @@ -194,6 +194,7 @@ const QList<QMailMessageSortKey::ArgumentType> &QMailMessageSortKey::arguments() /*! \fn QMailMessageSortKey::serialize(Stream &stream) const + \internal Writes the contents of a QMailMessageSortKey to a \a stream. */ @@ -204,6 +205,7 @@ template <typename Stream> void QMailMessageSortKey::serialize(Stream &stream) c /*! \fn QMailMessageSortKey::deserialize(Stream &stream) + \internal Reads the contents of a QMailMessageSortKey from \a stream. */ diff --git a/src/libraries/qmfclient/qmailthreadkey.cpp b/src/libraries/qmfclient/qmailthreadkey.cpp index 681e81c7..dcf44e70 100644 --- a/src/libraries/qmfclient/qmailthreadkey.cpp +++ b/src/libraries/qmfclient/qmailthreadkey.cpp @@ -292,6 +292,7 @@ QMailKey::Combiner QMailThreadKey::combiner() const /*! \fn QMailThreadKey::serialize(Stream &stream) const + \internal Writes the contents of a QMailThreadKey to a \a stream. */ @@ -302,6 +303,7 @@ template <typename Stream> void QMailThreadKey::serialize(Stream &stream) const /*! \fn QMailThreadKey::deserialize(Stream &stream) + \internal Reads the contents of a QMailThreadKey from \a stream. */ diff --git a/src/libraries/qmfclient/qmailthreadsortkey.cpp b/src/libraries/qmfclient/qmailthreadsortkey.cpp index 1956fc3d..593e2118 100644 --- a/src/libraries/qmfclient/qmailthreadsortkey.cpp +++ b/src/libraries/qmfclient/qmailthreadsortkey.cpp @@ -175,6 +175,7 @@ const QList<QMailThreadSortKey::ArgumentType> &QMailThreadSortKey::arguments() c /*! \fn QMailThreadSortKey::serialize(Stream &stream) const + \internal Writes the contents of a QMailThreadSortKey to a \a stream. */ @@ -185,6 +186,7 @@ template <typename Stream> void QMailThreadSortKey::serialize(Stream &stream) co /*! \fn QMailThreadSortKey::deserialize(Stream &stream) + \internal Reads the contents of a QMailThreadSortKey from \a stream. */ @@ -203,7 +205,6 @@ QMailThreadSortKey QMailThreadSortKey::id(Qt::SortOrder order) return QMailThreadSortKey(Id, order); } - /*! Returns a key that sorts threads by their account identifiers, according to \a order. |