summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorPekka Vuorela <pvuorela@iki.fi>2025-12-02 11:58:26 +0200
committerPekka Vuorela <pvuorela@iki.fi>2025-12-02 15:25:11 +0200
commit070ea2e6f1045757b13fd3263c84baa7bf866364 (patch)
tree5a29baabe64f1ef43af8901a098202071d0ef268
parent01da8d5d2b33037318f437c2b9bfff9f1aec1320 (diff)
Fix most of the local qdoc warnings from .cpp side
Bunch of parameters not having documentation or using wrong name. Some enums values also missing. Some other small adjustments while at it. Still bunch of warnings from failing to link methods to Qt etc or missing the explicit module. To be addressed separately. Change-Id: Ib6d3c261f9aa7a511dc8b7c0aa2a6357187841f9 Reviewed-by: Damien Caliste <dcaliste@free.fr> Reviewed-by: <matti.viljanen@kapsi.fi> Reviewed-by: Pekka Vuorela <pvuorela@iki.fi>
Diffstat
-rw-r--r--src/libraries/qmfclient/qmailaccount.cpp3
-rw-r--r--src/libraries/qmfclient/qmailaccountconfiguration.cpp7
-rw-r--r--src/libraries/qmfclient/qmailcrypto.cpp12
-rw-r--r--src/libraries/qmfclient/qmailcrypto.h2
-rw-r--r--src/libraries/qmfclient/qmailmessage.cpp18
-rw-r--r--src/libraries/qmfclient/qmailmessagekey.cpp2
-rw-r--r--src/libraries/qmfclient/qmailmessagemodelbase.cpp2
-rw-r--r--src/libraries/qmfclient/qmailmessageserver.cpp4
-rw-r--r--src/libraries/qmfclient/qmailserviceaction.cpp2
-rw-r--r--src/libraries/qmfclient/qmailthreadkey.cpp6
-rw-r--r--src/libraries/qmfclient/qmailthreadlistmodel.cpp4
-rw-r--r--src/libraries/qmfclient/support/qmailnamespace.cpp1
-rw-r--r--src/libraries/qmfmessageserver/qmailauthenticator.cpp8
-rw-r--r--src/libraries/qmfmessageserver/qmailcredentials.cpp8
-rw-r--r--src/libraries/qmfmessageserver/qmailmessageservice.cpp56
15 files changed, 85 insertions, 50 deletions
diff --git a/src/libraries/qmfclient/qmailaccount.cpp b/src/libraries/qmfclient/qmailaccount.cpp
index afa4a3c9..6ef9a23c 100644
--- a/src/libraries/qmfclient/qmailaccount.cpp
+++ b/src/libraries/qmfclient/qmailaccount.cpp
@@ -481,7 +481,8 @@ QMailAddress QMailAccount::fromAliases() const
}
/*!
- Sets the other addresses from which the account's outgoing messages can be reported as originating from.
+ Sets the other addresses from which the account's outgoing messages can be reported as originating from
+ as \a aliases.
\sa fromAliases(), setFromAddress()
*/
diff --git a/src/libraries/qmfclient/qmailaccountconfiguration.cpp b/src/libraries/qmfclient/qmailaccountconfiguration.cpp
index 16fa6b80..5695f84c 100644
--- a/src/libraries/qmfclient/qmailaccountconfiguration.cpp
+++ b/src/libraries/qmfclient/qmailaccountconfiguration.cpp
@@ -203,8 +203,8 @@ QString QMailAccountConfiguration::ServiceConfiguration::value(const QString &na
}
/*!
- Returns the value as a string list, if the value is not a list,
- status is set to false.
+ Returns the \a value as a string list, if the value is not a list,
+ \a status is set to false.
*/
QStringList QMailAccountConfiguration::ServiceConfiguration::asList(const QString &value, bool *status)
{
@@ -234,8 +234,7 @@ void QMailAccountConfiguration::ServiceConfiguration::setValue(const QString &na
}
/*!
- Returns the value as a string list, if the value is not a list,
- status is set to false.
+ Returns a string presentation of the \a list.
*/
QString QMailAccountConfiguration::ServiceConfiguration::fromList(const QStringList &list)
{
diff --git a/src/libraries/qmfclient/qmailcrypto.cpp b/src/libraries/qmfclient/qmailcrypto.cpp
index b6cf62e6..1a7297a8 100644
--- a/src/libraries/qmfclient/qmailcrypto.cpp
+++ b/src/libraries/qmfclient/qmailcrypto.cpp
@@ -284,7 +284,7 @@ QStringList QMailCryptographicServiceConfiguration::signatureKeys() const
}
/*!
- Stores the keys to be used when creating a cryptographic
+ Stores the \a keys to be used when creating a cryptographic
signature for an e-mail of this account.
\sa QMailCryptographicService::sign().
@@ -310,17 +310,17 @@ QString QMailCryptographicServiceConfiguration::signatureType() const
}
/*!
- Sets up the method to be used when creating a cryptographic
+ Sets up the \a method to be used when creating a cryptographic
signature for an e-mail of this account.
\sa QMailCryptographicService::sign().
*/
-void QMailCryptographicServiceConfiguration::setSignatureType(const QString &str)
+void QMailCryptographicServiceConfiguration::setSignatureType(const QString &method)
{
- if (str.isEmpty()) {
+ if (method.isEmpty()) {
d->m_cryptoConfig.removeValue(QStringLiteral("pluginName"));
} else {
- d->m_cryptoConfig.setValue(QStringLiteral("pluginName"), str);
+ d->m_cryptoConfig.setValue(QStringLiteral("pluginName"), method);
}
}
@@ -335,7 +335,7 @@ bool QMailCryptographicServiceConfiguration::useSignatureByDefault() const
/*!
Sets up if a cryptographic signature should be generated for
- every e-mail of this account.
+ every e-mail of this account according to \a status.
*/
void QMailCryptographicServiceConfiguration::setUseSignatureByDefault(bool status)
{
diff --git a/src/libraries/qmfclient/qmailcrypto.h b/src/libraries/qmfclient/qmailcrypto.h
index f6d33b43..ff9874c7 100644
--- a/src/libraries/qmfclient/qmailcrypto.h
+++ b/src/libraries/qmfclient/qmailcrypto.h
@@ -111,7 +111,7 @@ public:
void setSignatureKeys(const QStringList &keys);
QString signatureType() const;
- void setSignatureType(const QString &str);
+ void setSignatureType(const QString &method);
bool useSignatureByDefault() const;
void setUseSignatureByDefault(bool status);
diff --git a/src/libraries/qmfclient/qmailmessage.cpp b/src/libraries/qmfclient/qmailmessage.cpp
index 21c18c2a..63776dd6 100644
--- a/src/libraries/qmfclient/qmailmessage.cpp
+++ b/src/libraries/qmfclient/qmailmessage.cpp
@@ -2677,6 +2677,10 @@ void QMailMessageContentType::setCharset(const QByteArray& charset)
/*!
Allow to test if the content type matches a specific "type / subtype" string.
+ \a primary is the main type, and \a sub is the subtype.
+ Empty values match everything.
+
+ Returns true if the types match.
*/
bool QMailMessageContentType::matches(const QByteArray& primary, const QByteArray& sub) const
{
@@ -4847,8 +4851,10 @@ QMailMessagePartContainer::MultipartType QMailMessagePartContainer::multipartTyp
/*!
Sets the multipart state of the message to \a type.
+ The \a parameters can be used to set extra parameters on the 'Content-Type' header.
*/
-void QMailMessagePartContainer::setMultipartType(QMailMessagePartContainer::MultipartType type, const QList<QMailMessageHeaderField::ParameterType> &parameters)
+void QMailMessagePartContainer::setMultipartType(QMailMessagePartContainer::MultipartType type,
+ const QList<QMailMessageHeaderField::ParameterType> &parameters)
{
d->setMultipartType(type, parameters);
}
@@ -4907,7 +4913,8 @@ void QMailMessagePartContainer::setContentDisposition(const QMailMessageContentD
}
/*!
- Sets the part to contain the body element \a body, \a encodingStatus describes the current status of \a body regarding encoding. Any previous content of this part is deleted by the call.
+ Sets the part to contain the body element \a body, \a encodingStatus describes the current status of \a body
+ regarding encoding. Any previous content of this part is deleted by the call.
Note: No encoding/decoding operation will be performed in the body element, only the encoding status flag
will be set if provided.
*/
@@ -5097,7 +5104,7 @@ void QMailMessagePartContainer::appendHeaderField( const QString& id, const QStr
}
/*!
- Appends a new header field with the properties of \a field. If the \a id
+ Appends a new header field with the properties of \a field. If the header field id
should be present only once according to RFC2822 and is already existing,
it will be updated instead of appended.
*/
@@ -8231,6 +8238,11 @@ QMailMessage QMailMessage::fromSkeletonRfc2822File(const QString& fileName)
first part of the read receipt message. If \a subjectPrefix is provided, the
subject of the original message is kept and prefixed with \a subjectPrefix.
If not, a default subject is set as in the RFC example.
+ If a \a reportingUA parameter is provided, it will be used to indicate
+ the user-agent with a "Reporting-UA" header field.
+ The \a mode parameter defines whether the user explicitly gave permission to
+ send the receipt or whether it's done automatically.
+ The \a type parameter defines whether the message was displayed or deleted etc.
*/
QMailMessage QMailMessage::asReadReceipt(const QMailMessage &message, const QString &bodyText,
const QString &subjectPrefix,
diff --git a/src/libraries/qmfclient/qmailmessagekey.cpp b/src/libraries/qmfclient/qmailmessagekey.cpp
index fec58c1d..90840753 100644
--- a/src/libraries/qmfclient/qmailmessagekey.cpp
+++ b/src/libraries/qmfclient/qmailmessagekey.cpp
@@ -114,7 +114,7 @@ using namespace QMailKey;
\value RestoreFolderId The folderId this message could be untrashed to
\value ListId The list-id-namespace of this message
\value ParentThreadId The threadId of the thread (conversation) this message is in.
- \value Preview The preview text for this message. Normally upto 280 characters of the beginning text of the message.
+ \value Preview The preview text for this message. Normally some snippet of the text at the beginning.
\value RfcId The message rfcId, that is the message-id header field value.
*/
diff --git a/src/libraries/qmfclient/qmailmessagemodelbase.cpp b/src/libraries/qmfclient/qmailmessagemodelbase.cpp
index 7bea2337..41ee4d71 100644
--- a/src/libraries/qmfclient/qmailmessagemodelbase.cpp
+++ b/src/libraries/qmfclient/qmailmessagemodelbase.cpp
@@ -327,7 +327,7 @@ uint QMailMessageModelBase::limit() const
}
/*!
- Sets the max number of messages that model can hold, by default this value is zero, that means,
+ Sets the max number of messages that model can hold to \a limit. By default this value is zero, that means,
all messages matching the model sort key.
*/
void QMailMessageModelBase::setLimit(uint limit)
diff --git a/src/libraries/qmfclient/qmailmessageserver.cpp b/src/libraries/qmfclient/qmailmessageserver.cpp
index 90fbad38..3f12670f 100644
--- a/src/libraries/qmfclient/qmailmessageserver.cpp
+++ b/src/libraries/qmfclient/qmailmessageserver.cpp
@@ -520,6 +520,8 @@ void QMailMessageServer::retrieveNewMessages(quint64 action, const QMailAccountI
This function requires the device to be online, it may initiate communication
with external servers.
+ The request has the identifier \a action.
+
\sa retrieveFolderList
*/
void QMailMessageServer::createStandardFolders(quint64 action, const QMailAccountId &accountId)
@@ -749,7 +751,7 @@ void QMailMessageServer::onlineDeleteFolder(quint64 action, const QMailFolderId
/*!
Requests that the MessageServer move the folder identified by \a folderId.
- If \a parentId is a valid folder identifier the new folder will be a child of the parent;
+ If \a newParentId is a valid folder identifier the new folder will be a child of the parent;
otherwise the folder will be have no parent and will be created at the highest level.
The request has the identifier \a action.
diff --git a/src/libraries/qmfclient/qmailserviceaction.cpp b/src/libraries/qmfclient/qmailserviceaction.cpp
index c72900a4..a39a2a7c 100644
--- a/src/libraries/qmfclient/qmailserviceaction.cpp
+++ b/src/libraries/qmfclient/qmailserviceaction.cpp
@@ -401,6 +401,8 @@ void QMailServiceActionPrivate::emitChanges()
\value ErrInvalidData The supplied data is inappropriate for the requested action.
\value ErrTimeout The service failed to report any activity for an extended period.
\value ErrInternalStateReset The service was reset due to state change, such as an external process modifying the owner account.
+ \value ErrNoSslSupport No SSL support.
+ \value ErrUntrustedCertificates The SSL certificate is not trusted.
\value ErrorCodeMinimum The lowest value of any error condition code.
\value ErrorCodeMaximum The highest value of any error condition code.
*/
diff --git a/src/libraries/qmfclient/qmailthreadkey.cpp b/src/libraries/qmfclient/qmailthreadkey.cpp
index 8ef9b952..a4441757 100644
--- a/src/libraries/qmfclient/qmailthreadkey.cpp
+++ b/src/libraries/qmfclient/qmailthreadkey.cpp
@@ -73,6 +73,12 @@ Q_IMPLEMENT_USER_METATYPE(QMailThreadKey)
\value UnreadCount The number of unread messages in the thread.
\value Includes List of message identifiers.
\value ParentAccountId The identifier of the parent account of the thread.
+ \value Subject The subject of the thread.
+ \value Senders The message senders address strings on the thread.
+ \value LastDate The last date on the thread.
+ \value StartedDate The date when the thread started.
+ \value Status The message status flags.
+ \value Preview The preview text for this message. Normally some snippet of the text at the beginning.
\value Custom For internal use, may be removed.
*/
diff --git a/src/libraries/qmfclient/qmailthreadlistmodel.cpp b/src/libraries/qmfclient/qmailthreadlistmodel.cpp
index 8396361e..4542e2aa 100644
--- a/src/libraries/qmfclient/qmailthreadlistmodel.cpp
+++ b/src/libraries/qmfclient/qmailthreadlistmodel.cpp
@@ -178,8 +178,8 @@ QMailThreadIdList::iterator QMailThreadListModelPrivate::lowerBound(const QMailT
Represents common display roles of a thread. These roles are used to display common thread elements
in a view and its attached delegates.
- \value ThreadSubjectRole The subject of the thread
- \value ThreadPreviewRole The preview of the thread
+ \value ThreadSubjectTextRole The subject of the thread
+ \value ThreadPreviewTextRole The preview of the thread
\value ThreadUnreadCountRole The unread count of the thread
\value ThreadMessageCountRole The message count of the thread
\value ThreadSendersRole The senders of the thread
diff --git a/src/libraries/qmfclient/support/qmailnamespace.cpp b/src/libraries/qmfclient/support/qmailnamespace.cpp
index 8efa64b6..7f8fc261 100644
--- a/src/libraries/qmfclient/support/qmailnamespace.cpp
+++ b/src/libraries/qmfclient/support/qmailnamespace.cpp
@@ -576,4 +576,5 @@ bool QMail::isMessageServerRunning()
\value LoginMechanism Simple clear-text user/password authentication mechanism, obsoleted by Plain.
\value PlainMechanism Simple clear-text user/password authentication mechanism.
\value CramMd5Mechanism A challenge-response authentication mechanism.
+ \value XOAuth2Mechanism XOAuth2 authentication mechanism.
*/
diff --git a/src/libraries/qmfmessageserver/qmailauthenticator.cpp b/src/libraries/qmfmessageserver/qmailauthenticator.cpp
index a0df625b..01581f24 100644
--- a/src/libraries/qmfmessageserver/qmailauthenticator.cpp
+++ b/src/libraries/qmfmessageserver/qmailauthenticator.cpp
@@ -128,8 +128,9 @@ QMail::SaslMechanism QMailAuthenticator::authFromCapabilities(const QStringList
/*!
Returns the authentication string that should be used to initiate an authentication
- attempt for the service whose configuration is described by \a svcCfg. The
- authentication method is the one chosen in the service configuration.
+ attempt for the service whose configuration is described by \a svcCfg
+ and credentials by \a credentials.
+ The authentication method is the one chosen in the service configuration.
*/
QByteArray QMailAuthenticator::getAuthentication(const QMailServiceConfiguration &svcCfg,
const QMailCredentialsInterface &credentials)
@@ -147,7 +148,8 @@ QByteArray QMailAuthenticator::getAuthentication(const QMailServiceConfiguration
/*!
Returns the response string that should be reported as the response to a
- service's \a challenge, for the the service desribed by \a svcCfg.
+ service's \a challenge, for the the service desribed by \a svcCfg
+ and credentials by \a credentials.
If the protocol invoking the challenge-response resolution requires
encoding for the challenge-response tokens (such as Base64), the challenge
diff --git a/src/libraries/qmfmessageserver/qmailcredentials.cpp b/src/libraries/qmfmessageserver/qmailcredentials.cpp
index 8e324cc5..9f02ae84 100644
--- a/src/libraries/qmfmessageserver/qmailcredentials.cpp
+++ b/src/libraries/qmfmessageserver/qmailcredentials.cpp
@@ -267,7 +267,7 @@ QMailCredentialsInterface::~QMailCredentialsInterface()
/*!
This function is called by the protocol implementations each time
credentials are needed in a connection with a mail server. Parameters
- to retrieve the credentials can be stored in @svcCfg.
+ to retrieve the credentials can be stored in \a svcCfg.
When credentials are available, the credential implementation should
change the status to 'Ready'. If retrieving credentials is done
@@ -314,6 +314,8 @@ QString QMailCredentialsInterface::accessToken() const
/*!
This function is called by the protocol implementations when the mail
servers return from the authentication process with success.
+
+ \a source is the software component that managed to authenticate succesfully.
*/
void QMailCredentialsInterface::authSuccessNotice(const QString &source)
{
@@ -329,6 +331,8 @@ void QMailCredentialsInterface::authSuccessNotice(const QString &source)
Credential implementations can override this function to defer
invalidation if needed. For instance in the case of internal caching
requiring to refresh credentials...
+
+ \a source is the software component that failed doing authentication.
*/
void QMailCredentialsInterface::authFailureNotice(const QString &source)
{
@@ -357,6 +361,8 @@ bool QMailCredentialsInterface::shouldRetryAuth() const
working anymore. Credential implementation can override this method
to implement a mechanism that would notify that credentials need
to be reset by the user.
+
+ \a source is the software component invalidating the credentials.
*/
void QMailCredentialsInterface::invalidate(const QString &source)
{
diff --git a/src/libraries/qmfmessageserver/qmailmessageservice.cpp b/src/libraries/qmfmessageserver/qmailmessageservice.cpp
index 681a5f79..97bcb01a 100644
--- a/src/libraries/qmfmessageserver/qmailmessageservice.cpp
+++ b/src/libraries/qmfmessageserver/qmailmessageservice.cpp
@@ -414,7 +414,7 @@ QMailStore::MessageRemovalOption QMailMessageSource::messageRemovalOption() cons
folder that is searched for child folders; these properties are not updated
for folders that are merely discovered by searching.
- Return true if an operation is initiated.
+ Returns true if an operation is initiated.
\sa retrieveMessageList(), retrieveMessageLists()
*/
@@ -457,7 +457,7 @@ bool QMailMessageSource::retrieveFolderList(const QMailAccountId &accountId, con
that are present in the mail store will be updated including the QMailMessage::Read and
QMailMessage::Important flags.
- Return true if an operation is initiated.
+ Returns true if an operation is initiated.
\sa QMailAccount::lastSynchronized(), retrieveMessageLists()
*/
@@ -501,7 +501,7 @@ bool QMailMessageSource::retrieveMessageList(const QMailAccountId &accountId, co
that are present in the mail store will be updated including the QMailMessage::Read and
QMailMessage::Important flags.
- Return true if an operation is initiated.
+ Returns true if an operation is initiated.
\sa QMailAccount::lastSynchronized(), retrieveMessageList()
*/
@@ -516,7 +516,7 @@ bool QMailMessageSource::retrieveMessageLists(const QMailAccountId &accountId, c
return false;
}
-/*
+/*!
Requests that the message server retrieve new messages for the account \a accountId in the
folders specified by \a folderIds.
@@ -529,6 +529,7 @@ bool QMailMessageSource::retrieveMessageLists(const QMailAccountId &accountId, c
Detection of deleted messages, and flag updates for messages in the mail store will
not necessarily be performed.
+ Returns true if an operation is initiated.
*/
bool QMailMessageSource::retrieveNewMessages(const QMailAccountId &accountId, const QMailFolderIdList &folderIds)
{
@@ -555,7 +556,7 @@ bool QMailMessageSource::retrieveNewMessages(const QMailAccountId &accountId, co
QMailFolder::serverUndiscoveredCount() properties should be updated for each folder
from which messages are retrieved.
- Return true if an operation is initiated.
+ Returns true if an operation is initiated.
*/
bool QMailMessageSource::retrieveMessages(const QMailMessageIdList &ids, QMailRetrievalAction::RetrievalSpecification spec)
{
@@ -575,7 +576,7 @@ bool QMailMessageSource::retrieveMessages(const QMailMessageIdList &ids, QMailRe
QMailFolder::serverUndiscoveredCount() properties should be updated for the folder
from which the part is retrieved.
- Return true if an operation is initiated.
+ Returns true if an operation is initiated.
*/
bool QMailMessageSource::retrieveMessagePart(const QMailMessagePart::Location &partLocation)
{
@@ -595,7 +596,7 @@ bool QMailMessageSource::retrieveMessagePart(const QMailMessagePart::Location &p
QMailFolder::serverUndiscoveredCount() properties should be updated for the folder
from which the message is retrieved.
- Return true if an operation is initiated.
+ Returns true if an operation is initiated.
*/
bool QMailMessageSource::retrieveMessageRange(const QMailMessageId &messageId, uint minimum)
{
@@ -616,7 +617,7 @@ bool QMailMessageSource::retrieveMessageRange(const QMailMessageId &messageId, u
QMailFolder::serverUndiscoveredCount() properties should be updated for the folder
from which the part is retrieved.
- Return true if an operation is initiated.
+ Returns true if an operation is initiated.
*/
bool QMailMessageSource::retrieveMessagePartRange(const QMailMessagePart::Location &partLocation, uint minimum)
{
@@ -642,7 +643,7 @@ bool QMailMessageSource::retrieveMessagePartRange(const QMailMessagePart::Locati
in the mail store but found to be no longer available should be marked with the
\l QMailMessage::Removed status flag.
- Return true if an operation is initiated.
+ Returns true if an operation is initiated.
\sa QMailAccount::lastSynchronized(), retrieveFolderList(), retrieveMessageList(), retrieveMessageLists(), synchronize()
*/
@@ -660,7 +661,7 @@ bool QMailMessageSource::retrieveAll(const QMailAccountId &accountId)
Update the external server with any changes to message status that have been
effected on the local device for account \a accountId.
- Return true if an operation is initiated.
+ Returns true if an operation is initiated.
\sa synchronize()
*/
@@ -690,7 +691,7 @@ bool QMailMessageSource::exportUpdates(const QMailAccountId &accountId)
QMailFolder::serverUndiscoveredCount() properties should be updated for each folder, and
the lastSynchronized() time of the account updated.
- Return true if an operation is initiated.
+ Returns true if an operation is initiated.
\sa QMailAccount::lastSynchronized(), retrieveAll(), exportUpdates()
*/
@@ -707,7 +708,7 @@ bool QMailMessageSource::synchronize(const QMailAccountId &accountId)
Delete all messages listed in \a ids from the local mail store and the external server.
- Return true if an operation is initiated.
+ Returns true if an operation is initiated.
\sa messagesDeleted()
*/
@@ -725,7 +726,7 @@ bool QMailMessageSource::deleteMessages(const QMailMessageIdList &ids)
Successfully copied messages should be progressively reported via messagesCopied().
- Return true if an operation is initiated.
+ Returns true if an operation is initiated.
\sa messagesCopied()
*/
@@ -744,7 +745,7 @@ bool QMailMessageSource::copyMessages(const QMailMessageIdList &ids, const QMail
Successfully moved messages should be progressively reported via messagesMoved().
- Return true if an operation is initiated.
+ Returns true if an operation is initiated.
\sa messagesMoved()
*/
@@ -766,7 +767,7 @@ bool QMailMessageSource::moveMessages(const QMailMessageIdList &ids, const QMail
Successfully modified messages should be progressively reported via messagesFlagged().
- Return true if an operation is initiated.
+ Returns true if an operation is initiated.
\sa messagesFlagged()
*/
@@ -786,7 +787,7 @@ bool QMailMessageSource::flagMessages(const QMailMessageIdList &ids, quint64 set
If \a parentId is a valid folder identifier the new folder will be a child of the parent;
otherwise the folder will be have no parent and will be created at the highest level.
- Return true if an operation is initiated.
+ Returns true if an operation is initiated.
\sa deleteFolder()
*/
@@ -814,7 +815,7 @@ bool QMailMessageSource::createStandardFolders(const QMailAccountId &accountId)
Renames the folder identified by \a folderId to \a name. The location of the folder
in the existing hierarchy should not change.
- Return true if an operation is initiated.
+ Returns true if an operation is initiated.
\sa deleteFolder(), createFolder()
*/
@@ -833,7 +834,7 @@ bool QMailMessageSource::renameFolder(const QMailFolderId &folderId, const QStri
Deletes the folder identified by \a folderId. It is the responsibility of the
message source to ensure all subfolders and messages are also deleted.
- Return true if an operation is initiated.
+ Returns true if an operation is initiated.
\sa createFolder()
*/
@@ -851,7 +852,7 @@ bool QMailMessageSource::deleteFolder(const QMailFolderId &folderId)
Moves the folder identified by \a folderId to a folder identified by \a newParentId.
The name of the folder should not change.
- Return true if an operation is initiated.
+ Returns true if an operation is initiated.
\sa deleteFolder(), createFolder(), renameFolder()
*/
@@ -913,7 +914,7 @@ bool QMailMessageSource::searchMessages(const QMailMessageKey &searchCriteria, c
meta data form marked with the \l QMailMessage::New status flag, and
progressively reported via matchingMessageIds().
- Return true if a search operation is initiated.
+ Returns true if a search operation is initiated.
\sa matchingMessageIds(), retrieveMessages()
*/
@@ -970,7 +971,7 @@ bool QMailMessageSource::cancelSearch()
Messages successfully prepared for transmission should be progressively reported via messagesPrepared().
- Return true if an operation is initiated.
+ Returns true if an operation is initiated.
\sa messagesPrepared()
*/
@@ -990,7 +991,7 @@ bool QMailMessageSource::prepareMessages(const QList<QPair<QMailMessagePart::Loc
Any responses resulting from the action should be progressively reported via protocolResponse().
- Return true if an operation is initiated.
+ Returns true if an operation is initiated.
\sa protocolResponse()
*/
@@ -1269,12 +1270,13 @@ QMailMessageSink::~QMailMessageSink()
Successfully transmitted messages should be progressively reported via messagesTransmitted().
- Messages for which for which an unsuccessful attempt to transmit has been made should be progressively reported via messagesFailedTransmission().
+ Messages for which for which an unsuccessful attempt to transmit has been made should be progressively
+ reported via messagesFailedTransmission().
If \a ids is an empty list, the sink should still proceed through all the steps necessary when transmitting messages,
as this action may be invoked to test the viability of the connection.
- Return true if an operation is initiated.
+ Returns true if an operation is initiated.
*/
bool QMailMessageSink::transmitMessages(const QMailMessageIdList &ids)
{
@@ -1404,7 +1406,8 @@ QMailMessageSink &QMailMessageService::sink() const
Returns true if requests to reregister the service should be honored; otherwise returns false.
- An attempt to reregister the service is made when the account for which this service is configured is modified, or when an action associated with the service expires.
+ An attempt to reregister the service is made when the account for which this service is configured is modified,
+ or when an action associated with the service expires.
*/
/*!
@@ -1474,7 +1477,8 @@ QMailMessageSink &QMailMessageService::sink() const
*/
/*!
- Emits the statusChanged() signal with the Status object constructed from \a code, \a text, \a accountId, \a folderId, \a messageId and \a action.
+ Emits the statusChanged() signal with the Status object constructed from \a code, \a text, \a accountId,
+ \a folderId, \a messageId and \a action.
If possible, a standardized error message is determined from \a code, and prepended to the error message.
*/
generated by cgit v1.2.3 (git 2.25.1) at 2025-12-14 12:40:15 +0000