diff options
| author | Pekka Vuorela <pvuorela@iki.fi> | 2025-12-01 16:12:06 +0200 |
|---|---|---|
| committer | Pekka Vuorela <pvuorela@iki.fi> | 2025-12-02 15:25:17 +0200 |
| commit | b18b41ebd266a5126c82812bacdd3503350bbb43 (patch) | |
| tree | 3135e1771c7d2d5db3c34cf2af3073e61a5551c9 | |
| parent | 070ea2e6f1045757b13fd3263c84baa7bf866364 (diff) | |
Fix some more mechanical documentation details
- \bold, \o and \i are deprecated in favor or \b, \li and \e
- qdoc complains about \brief not ending in full stop
- \sa should end in comma or no punctuation character
Change-Id: I6bdc3757d63578c3895e7b1cad8b32773257d965
Reviewed-by: <matti.viljanen@kapsi.fi>
Reviewed-by: Pekka Vuorela <pvuorela@iki.fi>
Reviewed-by: Damien Caliste <dcaliste@free.fr>
| -rw-r--r-- | doc/src/api/groups.qdoc | 20 | ||||
| -rw-r--r-- | doc/src/index.qdoc | 28 | ||||
| -rw-r--r-- | doc/src/messageserver.qdoc | 66 | ||||
| -rw-r--r-- | doc/src/messaging.qdoc | 12 | ||||
| -rw-r--r-- | doc/src/qtmail.qdoc | 156 | ||||
| -rw-r--r-- | doc/src/qtopiamail.qdoc | 106 | ||||
| -rw-r--r-- | doc/src/qtopiamail_messageserver.qdoc | 26 | ||||
| -rw-r--r-- | doc/src/qtopiamail_qmfutil.qdoc | 8 | ||||
| -rw-r--r-- | src/libraries/qmfclient/qmailaccountconfiguration.cpp | 8 | ||||
| -rw-r--r-- | src/libraries/qmfclient/qmailaction.cpp | 3 | ||||
| -rw-r--r-- | src/libraries/qmfclient/qmailaddress.cpp | 2 | ||||
| -rw-r--r-- | src/libraries/qmfclient/qmailcrypto.cpp | 8 | ||||
| -rw-r--r-- | src/libraries/qmfclient/qmailfolder.cpp | 2 | ||||
| -rw-r--r-- | src/libraries/qmfclient/qmailserviceaction.cpp | 4 | ||||
| -rw-r--r-- | src/libraries/qmfmessageserver/qmailcredentials.cpp | 2 |
15 files changed, 225 insertions, 226 deletions
diff --git a/doc/src/api/groups.qdoc b/doc/src/api/groups.qdoc index d7edabac..e5109316 100644 --- a/doc/src/api/groups.qdoc +++ b/doc/src/api/groups.qdoc @@ -38,12 +38,12 @@ \table 100% \header - \o Group - \o Description + \li Group + \li Description \row - \o \l{Messaging Client Utility Classes} - \o Classes that provide GUI elements that assist with the development of messaging client applications. + \li \l{Messaging Client Utility Classes} + \li Classes that provide GUI elements that assist with the development of messaging client applications. \endtable @@ -53,16 +53,16 @@ \table 100% \header - \o Group - \o Description + \li Group + \li Description \row - \o \l{Messaging Classes} - \o Classes that provide support for manipulating messages. + \li \l{Messaging Classes} + \li Classes that provide support for manipulating messages. \row - \o \l{Message Server Support Classes} - \o Classes that assist with building components that provide services for the message server. + \li \l{Message Server Support Classes} + \li Classes that assist with building components that provide services for the message server. \endtable diff --git a/doc/src/index.qdoc b/doc/src/index.qdoc index 9e0187f0..f0118aeb 100644 --- a/doc/src/index.qdoc +++ b/doc/src/index.qdoc @@ -33,24 +33,24 @@ \table 100% -\header -\o Reference Documentation -\o Using Messaging Framework -\o +\header +\li Reference Documentation +\li Using Messaging Framework +\li \row -\o +\li \list - \o \l {Class Index}{Classes } - \o \l {Grouped Classes}{Grouped Classes} - \o \l {Messaging Framework Namespaces}{Namespace List} - \o \l {Messaging Framework Class Inheritance Hierarchy}{Class Hierarchy} - \o \l {Annotated Class List}{Annotated Classes } + \li \l {Class Index}{Classes } + \li \l {Grouped Classes}{Grouped Classes} + \li \l {Messaging Framework Namespaces}{Namespace List} + \li \l {Messaging Framework Class Inheritance Hierarchy}{Class Hierarchy} + \li \l {Annotated Class List}{Annotated Classes } \endlist -\o +\li \list - \o \l {Messaging}{Introduction} - \o \l {Changes Between Messaging Framework Versions} - \o \l {Messaging Framework Client Library#Examples}{Examples} + \li \l {Messaging}{Introduction} + \li \l {Changes Between Messaging Framework Versions} + \li \l {Messaging Framework Client Library#Examples}{Examples} \endlist \endtable diff --git a/doc/src/messageserver.qdoc b/doc/src/messageserver.qdoc index d2a78dd6..5c318b79 100644 --- a/doc/src/messageserver.qdoc +++ b/doc/src/messageserver.qdoc @@ -33,7 +33,7 @@ \section1 Introduction -The \i MessageServer application provides message transport services to Messaging Framework client applications. +The \e MessageServer application provides message transport services to Messaging Framework client applications. It can send and retrieve messages of various types, to and from external message service providers such as POP and IMAP servers, or local resources such as a SIM card. Protocol implementations are loaded from plugin libraries, so that the system can be extended with new services, without modification to the MessageServer application. @@ -45,25 +45,25 @@ If the MessageServer experiences a fault and restarts, clients do not need to re Messages provides the following features: \table -\header \o Feature \o Description +\header \li Feature \li Description \row -\o Send messages -\o Send messages via the transport mechanism defined for the associated account. +\li Send messages +\li Send messages via the transport mechanism defined for the associated account. \row -\o Retrieve folder and message lists -\o Report the list of folders and messages available at the server for an account. +\li Retrieve folder and message lists +\li Report the list of folders and messages available at the server for an account. \row -\o Retrieve messages -\o Retrieve the content of specified messages from the originating server, either partially or completely. +\li Retrieve messages +\li Retrieve the content of specified messages from the originating server, either partially or completely. \row -\o Search messages -\o Search for messages via arbitrary criteria, performed at the originating server. +\li Search messages +\li Search for messages via arbitrary criteria, performed at the originating server. \row -\o Manage messages -\o Move, copy and delete messages on the originating server. +\li Manage messages +\li Move, copy and delete messages on the originating server. \row -\o Status reporting -\o Status and progress information is emitted during MessageServer operations, for the benefit of client applications. +\li Status reporting +\li Status and progress information is emitted during MessageServer operations, for the benefit of client applications. \endtable \section1 Accounts @@ -71,33 +71,33 @@ Messages provides the following features: MessageServer supports the following aspects of messaging accounts: \table -\header \o Feature \o Description +\header \li Feature \li Description \row -\o Unrestricted accounts -\o MessageServer supports any number of messaging accounts. +\li Unrestricted accounts +\li MessageServer supports any number of messaging accounts. \row -\o Messaging types -\o MessageServer supports accounts using the following messaging types: +\li Messaging types +\li MessageServer supports accounts using the following messaging types: \list -\o SMS -\o MMS -\o Email -\o Instant Messaging servics +\li SMS +\li MMS +\li Email +\li Instant Messaging servics \endlist \row -\o Email protocols -\o The following email protocols are available: +\li Email protocols +\li The following email protocols are available: \list -\o POP -\o SMTP -\o IMAP +\li POP +\li SMTP +\li IMAP \endlist Other protocols can be supported by providing implementations as plugins. \row -\o Instant Messaging protocols -\o The following Instant Messaging protocols are available: +\li Instant Messaging protocols +\li The following Instant Messaging protocols are available: \list -\o XMPP (Jabber) +\li XMPP (Jabber) \endlist Other protocols can be supported by providing implementations as plugins. \endtable @@ -111,8 +111,8 @@ Some actions of the MessageServer process affect the Messaging Framework data st \section1 Dependencies MessageServer has the following dependencies: \list -\o the \l{Messaging Framework Client Library} -\o the \l{Message Server Support Library} +\li the \l{Messaging Framework Client Library} +\li the \l{Message Server Support Library} \endlist \section1 Logging diff --git a/doc/src/messaging.qdoc b/doc/src/messaging.qdoc index daee220c..419a490b 100644 --- a/doc/src/messaging.qdoc +++ b/doc/src/messaging.qdoc @@ -35,9 +35,9 @@ The Messaging Framework provides the following messaging features: \list 1 -\o a library for developing applications that work with messages -\o a server application supporting multiple messaging transport mechanisms -\o an example client application supporting common messaging functionality +\li a library for developing applications that work with messages +\li a server application supporting multiple messaging transport mechanisms +\li an example client application supporting common messaging functionality \endlist The \l{Messaging Framework Client Library}{Client library} provides classes giving access to all messages stored on the device, via a uniform interface. @@ -70,9 +70,9 @@ Messaging clients do not need to communicate with the server directly. For detailed information refer to: \list -\o \l{Messaging Framework Client Library}{Client library} -\o \l{MessageServer Daemon}{MessageServer server daemon} -\o \l{Messages Client}{Messages client application} +\li \l{Messaging Framework Client Library}{Client library} +\li \l{MessageServer Daemon}{MessageServer server daemon} +\li \l{Messages Client}{Messages client application} \endlist \section1 Changes Between Messaging Framework Versions diff --git a/doc/src/qtmail.qdoc b/doc/src/qtmail.qdoc index 19a03e7d..d471d89c 100644 --- a/doc/src/qtmail.qdoc +++ b/doc/src/qtmail.qdoc @@ -34,7 +34,7 @@ \section1 Introduction -The \i Messages example client application enables the user to receive emails from multiple mail servers, using any of the protocols supported by the \l{MessageServer Daemon}{MessageServer}. +The \e Messages example client application enables the user to receive emails from multiple mail servers, using any of the protocols supported by the \l{MessageServer Daemon}{MessageServer}. It also provides the ability to send messages to multiple recipients, with or without attachments. \section1 Features @@ -42,67 +42,67 @@ It also provides the ability to send messages to multiple recipients, with or wi Messages provides the following features: \table -\header \o Feature \o Description +\header \li Feature \li Description \row -\o Send email -\o Compose and send an email. +\li Send email +\li Compose and send an email. \row -\o Receive email -\o Connect to a mail server and download emails to the device. +\li Receive email +\li Connect to a mail server and download emails to the device. \row -\o Reply to messages -\o Reply to a message received via the Messaging Framework. +\li Reply to messages +\li Reply to a message received via the Messaging Framework. \row -\o View an embedded image -\o View a message with an image either attached or embedded. +\li View an embedded image +\li View a message with an image either attached or embedded. \row -\o View specific messages -\o Filter the messages viewed. For example, view only messages in the current month. +\li View specific messages +\li Filter the messages viewed. For example, view only messages in the current month. \row -\o Search for a message -\o Search the contents of messages and retrieve valid messages. +\li Search for a message +\li Search the contents of messages and retrieve valid messages. \row -\o Multiple mail servers -\o View emails sent to multiple mail servers. +\li Multiple mail servers +\li View emails sent to multiple mail servers. For example view messages sent to both a work email address and a personal email address. \row -\o Save attachments -\o Receive a message with an attachment save it in their documents for later viewing. +\li Save attachments +\li Receive a message with an attachment save it in their documents for later viewing. \endtable \section1 Accounts The following account features are available: \table -\header \o Feature \o Description +\header \li Feature \li Description \row -\o Accounts \o Allows creation of an arbitrary number of mail accounts. +\li Accounts \li Allows creation of an arbitrary number of mail accounts. \row -\o Email Protocols -\o The following email protocols are provided (other protocols can be added to the MessageServer via pluins): +\li Email Protocols +\li The following email protocols are provided (other protocols can be added to the MessageServer via pluins): \list -\o POP -\o IMAP -\o SMTP +\li POP +\li IMAP +\li SMTP \endlist \row -\o Delete \o Allows a delay of server deletion of email until removed locally from trash. +\li Delete \li Allows a delay of server deletion of email until removed locally from trash. \endtable \section1 Folders The following folder features are available: \table -\header \o Feature \o Description +\header \li Feature \li Description \row -\o Folders \o supports both standard and virtual folders +\li Folders \li supports both standard and virtual folders \row -\o Queries \o supports creaton of an arbitrary number of virtual folders by adding new queries +\li Queries \li supports creaton of an arbitrary number of virtual folders by adding new queries \row -\o Search \o facilitates quick searches for email by using the search folder +\li Search \li facilitates quick searches for email by using the search folder \row -\o Mail Account \o each mail account is automatically assigned a virtual folder +\li Mail Account \li each mail account is automatically assigned a virtual folder \row \endtable @@ -110,132 +110,132 @@ The following folder features are available: The following mail list features are available: \table -\header \o Feature \o Description +\header \li Feature \li Description \row -\o Mail view \o displays a short description of each mail consisting of status, address, subject and date. +\li Mail view \li displays a short description of each mail consisting of status, address, subject and date. \row -\o Mail sort \o it is possible to select each header file for sorting in either ascending or descending order. +\li Mail sort \li it is possible to select each header file for sorting in either ascending or descending order. \row -\o Mail view update \o the view is dynamically updated as folder or mail contents changes. +\li Mail view update \li the view is dynamically updated as folder or mail contents changes. \row -\o Transfer \o it is possible to select messages and to copy or move them to another folder. +\li Transfer \li it is possible to select messages and to copy or move them to another folder. \endtable \section2 Virtual Folder Queries and Search The following virtual folder features are available: \table -\header \o Feature \o Description +\header \li Feature \li Description \row -\o Folder properties \o defines the search criteria for mails that appear in a folder. +\li Folder properties \li defines the search criteria for mails that appear in a folder. \row -\o Search keys \o allows case-insensitive pattern matching with support for optional keys in the same field. +\li Search keys \li allows case-insensitive pattern matching with support for optional keys in the same field. \row -\o Virtual properties \o the same mail logically appears in several folders. +\li Virtual properties \li the same mail logically appears in several folders. \endtable \section1 Message Properties The following message properties can be handled: \table -\header \o Property \o Description +\header \li Property \li Description \row -\o Date \o this is converted to match your current time zone setting +\li Date \li this is converted to match your current time zone setting \row -\o Attachments \o these are only stored as files when you request it +\li Attachments \li these are only stored as files when you request it \row -\o Usability \o support exists for most messages conforming to RFC2822 and RFC2045-RFC2049 +\li Usability \li support exists for most messages conforming to RFC2822 and RFC2045-RFC2049 \endtable \section1 Viewing mail The following features are available: \table -\header \o Feature \o Description +\header \li Feature \li Description \row -\o URL \o clicking on a URL in the mail prompts the application to attempt to open it in the default browser +\li URL \li clicking on a URL in the mail prompts the application to attempt to open it in the default browser \row -\o Addresses \o used to compose messages but it is also be possible to add an address/phone number to the address book by clicking on it +\li Addresses \li used to compose messages but it is also be possible to add an address/phone number to the address book by clicking on it \row -\o Format \o quoted text is colored to distinguish it from the body text +\li Format \li quoted text is colored to distinguish it from the body text \row -\o Inline \o text and image attachments are shown in-line with images being scaled to the screen width +\li Inline \li text and image attachments are shown in-line with images being scaled to the screen width \row -\o Attachments \o it is possible to install/remove mail attachments from the documents tab +\li Attachments \li it is possible to install/remove mail attachments from the documents tab \row -\o Reply \o it is possible to reply to or forward the currently viewed message +\li Reply \li it is possible to reply to or forward the currently viewed message \row -\o Status \o it is possible to change the status of messages +\li Status \li it is possible to change the status of messages \row -\o Plain \o the mail is shown in plain mode where the original formatting is kept +\li Plain \li the mail is shown in plain mode where the original formatting is kept \row -\o Delete \o it is possible to delete the currently viewed message +\li Delete \li it is possible to delete the currently viewed message \endtable \section1 Writing Messages The following features are available: \table -\header \o Feature \o Description +\header \li Feature \li Description \row -\o Fields \o it is possible to add SMS \c /To/Cc/Bcc/From/Subject/body(text) and attach files to the mail +\li Fields \li it is possible to add SMS \c /To/Cc/Bcc/From/Subject/body(text) and attach files to the mail \row -\o Modify \o it is possible to make changes as necessary to mails in the Drafts and \c Outbox folder +\li Modify \li it is possible to make changes as necessary to mails in the Drafts and \c Outbox folder \row -\o Auto save \o modified drafts are automatically saved unless they are explicitly discarded +\li Auto save \li modified drafts are automatically saved unless they are explicitly discarded \row -\o Store \o draft mails are stored in the Drafts folder and mails ready to send are stored in the \c Outbox folder +\li Store \li draft mails are stored in the Drafts folder and mails ready to send are stored in the \c Outbox folder \endtable \section1 Retrieving messages The following message retrieval related features are available: \table -\header \o Feature \o Description +\header \li Feature \li Description \row -\o Retrieve \o it is possible to check for new messages in either all accounts or to specify only one account to be checked +\li Retrieve \li it is possible to check for new messages in either all accounts or to specify only one account to be checked \row -\o Complete messages \o messages not downloaded are individually completed +\li Complete messages \li messages not downloaded are individually completed \row -\o Overview \o all new/unseen mail-headers are always downloaded (unless excused in IMAP mailbox settings) +\li Overview \li all new/unseen mail-headers are always downloaded (unless excused in IMAP mailbox settings) \row -\o Fast \o the current download list is sorted by the size of the mail (small goes first) +\li Fast \li the current download list is sorted by the size of the mail (small goes first) \row -\o Logical \o viewing a mail or removing it causes it to be respectively pushed to the front or removed from the download list +\li Logical \li viewing a mail or removing it causes it to be respectively pushed to the front or removed from the download list \row -\o Resume \o it is possible to cancel downloads and resume them later +\li Resume \li it is possible to cancel downloads and resume them later \row -\o Safe \o in case of a crash while downloading the client reverts to the state prior to the crash +\li Safe \li in case of a crash while downloading the client reverts to the state prior to the crash \endtable \section1 Sending messages The following message sending- related features are available: \table -\header \o Feature \o Description +\header \li Feature \li Description \row -\o Send \o it is possible to send all queued messages in one go. +\li Send \li it is possible to send all queued messages in one go. \row -\o Authenticate \o POP or IMAP authentication is always attempted. +\li Authenticate \li POP or IMAP authentication is always attempted. \row -\o Fallback \o sending is attempted even if authentication fails (for whatever reasons). +\li Fallback \li sending is attempted even if authentication fails (for whatever reasons). \row -\o Single \o it is possible to send a single mail instead of all the mails in the Outbox. +\li Single \li it is possible to send a single mail instead of all the mails in the Outbox. \row -\o Safe \o in event of failure no mail in the transfer list is marked as sent. +\li Safe \li in event of failure no mail in the transfer list is marked as sent. \row -\o Sent Folder \o all sent mails are automatically be moved to the Sent folder. +\li Sent Folder \li all sent mails are automatically be moved to the Sent folder. \row -\o Flexible \o default SMTP account or reply-to field is used where the from address does not match. +\li Flexible \li default SMTP account or reply-to field is used where the from address does not match. \row -\o Diverse \o it is possible to send a single message with both SMS and email addresses. +\li Diverse \li it is possible to send a single message with both SMS and email addresses. \endtable \section1 Dependencies Messages has the following dependencies: \list -\o the \l{Messaging Framework Client Library} -\o the \l{Messaging Client Utility Library} +\li the \l{Messaging Framework Client Library} +\li the \l{Messaging Client Utility Library} \endlist */ diff --git a/doc/src/qtopiamail.qdoc b/doc/src/qtopiamail.qdoc index 0f2046ab..ba489a75 100644 --- a/doc/src/qtopiamail.qdoc +++ b/doc/src/qtopiamail.qdoc @@ -44,8 +44,8 @@ For detailed class information refer to: \l{Messaging Classes}. The library is augmented by two related, more specific libraries: \list -\o the \l{Messaging Client Utility Library}{Client utility} library provides classes that assist with building GUI messaging client applications, and -\o the \l{Message Server Support Library}{Server support} library provides classes that assist with creating plugin components for the \l{MessageServer Daemon}{Message Server} daemon. +\li the \l{Messaging Client Utility Library}{Client utility} library provides classes that assist with building GUI messaging client applications, and +\li the \l{Message Server Support Library}{Server support} library provides classes that assist with creating plugin components for the \l{MessageServer Daemon}{Message Server} daemon. \endlist \section1 Composition and Manipulation of Messages @@ -57,19 +57,19 @@ Messages can be composed of multiple parts and constructed hierarchically. The C Classes to assist with composition and manipulation of messages: \table -\header \o Class \o Description -\row \o QMailMessageId \o Represents the mail store identifiers for message records. -\row \o QMailMessageMetaData \o Represents a message stored by the Messaging Framework. -\row \o QMailMessage \o Convenient interface for working with messages. -\row \o QMailMessagePart \o Convenient interface for working with message attachments. -\row \o QMailMessagePartContainer \o Access to a collection of message parts. -\row \o QMailMessageBody \o The body element of a message or message part. -\row \o QMailMessageHeaderField \o Encapsulates the parsing of message header fields. -\row \o QMailMessageContentDisposition \o Encapsulates the parsing of the RFC 2822 'Content-Disposition' header field. -\row \o QMailMessageContentType \o Encapsulates the parsing of the RFC 2822 'Content-Type' header field. -\row \o QMailAddress \o Interface for manipulating message address strings. -\row \o QMailTimeStamp \o Manages message time stamps. -\row \o QMailCodec \o Base class for classes implementing codecs used in message composition. +\header \li Class \li Description +\row \li QMailMessageId \li Represents the mail store identifiers for message records. +\row \li QMailMessageMetaData \li Represents a message stored by the Messaging Framework. +\row \li QMailMessage \li Convenient interface for working with messages. +\row \li QMailMessagePart \li Convenient interface for working with message attachments. +\row \li QMailMessagePartContainer \li Access to a collection of message parts. +\row \li QMailMessageBody \li The body element of a message or message part. +\row \li QMailMessageHeaderField \li Encapsulates the parsing of message header fields. +\row \li QMailMessageContentDisposition \li Encapsulates the parsing of the RFC 2822 'Content-Disposition' header field. +\row \li QMailMessageContentType \li Encapsulates the parsing of the RFC 2822 'Content-Type' header field. +\row \li QMailAddress \li Interface for manipulating message address strings. +\row \li QMailTimeStamp \li Manages message time stamps. +\row \li QMailCodec \li Base class for classes implementing codecs used in message composition. \endtable \section1 Message Accounts @@ -80,13 +80,13 @@ messaging accounts both outgoing and incoming. Classes relating to messaging accounts: \table -\header \o Class \o Description -\row \o QMailAccountId \o Represents the mail store identifiers for account records. -\row \o QMailAccount \o Stores attributes for a messaging account. -\row \o QMailFolderId \o Represents the mail store identifiers for folder records. -\row \o QMailFolder \o Represents a folder for messages on the mail store. -\row \o QMailMessageRemovalRecord \o Represents a message deleted from the local mail store. -\row \o QMailAccountConfiguration \o Contains the configuration details for an account. +\header \li Class \li Description +\row \li QMailAccountId \li Represents the mail store identifiers for account records. +\row \li QMailAccount \li Stores attributes for a messaging account. +\row \li QMailFolderId \li Represents the mail store identifiers for folder records. +\row \li QMailFolder \li Represents a folder for messages on the mail store. +\row \li QMailMessageRemovalRecord \li Represents a message deleted from the local mail store. +\row \li QMailAccountConfiguration \li Contains the configuration details for an account. \endtable \section1 Message threads @@ -97,9 +97,9 @@ message threads (a.k.a. conversations). Classes relating to message threads: \table -\header \o Class \o Description -\row \o QMailThreadId \o Represents the mail store identifiers for thread records. -\row \o QMailThread \o Stores attributes for a message thread. +\header \li Class \li Description +\row \li QMailThreadId \li Represents the mail store identifiers for thread records. +\row \li QMailThread \li Stores attributes for a message thread. \endtable \section1 Message Listing @@ -110,9 +110,9 @@ display lists of messages and accounts with minimal effort, and with minimal res Classes to assist with listing messages: \table -\header \o Class \o Description -\row \o QMailAccountListModel \o Provides a model representing the accounts stored by the Messaging Framework. -\row \o QMailMessageListModel \o Provides a model representing the messages stored by the Messaging Framework. +\header \li Class \li Description +\row \li QMailAccountListModel \li Provides a model representing the accounts stored by the Messaging Framework. +\row \li QMailMessageListModel \li Provides a model representing the messages stored by the Messaging Framework. \endtable \section1 Message Navigation @@ -124,12 +124,12 @@ taxonomy of message data, using standard or arbitrary categorization criteria. Classes to assist with navigating messages: \table -\header \o Class \o Description -\row \o QMailMessageSet \o Provides a representation for a subset of the store's messages, suitable for display in a tree view. -\row \o QMailAccountMessageSet \o Provides a message set implementation grouping messages by their parent account ID. -\row \o QMailFolderMessageSet \o Provides a message set implementation grouping messages by their parent folder ID. -\row \o QMailFilterMessageSet \o Provides a message set implementation grouping messages by arbitrary criteria. -\row \o QMailMessageSetModel \o Provides a model representing arbitrary message sets in a tree arrangement. +\header \li Class \li Description +\row \li QMailMessageSet \li Provides a representation for a subset of the store's messages, suitable for display in a tree view. +\row \li QMailAccountMessageSet \li Provides a message set implementation grouping messages by their parent account ID. +\row \li QMailFolderMessageSet \li Provides a message set implementation grouping messages by their parent folder ID. +\row \li QMailFilterMessageSet \li Provides a message set implementation grouping messages by arbitrary criteria. +\row \li QMailMessageSetModel \li Provides a model representing arbitrary message sets in a tree arrangement. \endtable \section1 Sorting and Searching Functionality @@ -145,16 +145,16 @@ Search conditions can be combined to produce searches of arbitrary complexity. Classes to assist with sorting and searching messages: \table -\header \o Class \o Description -\row \o QMailStore \o Represents the main interface for storage and retrieval of messages and folders on the mail store. -\row \o QMailAccountKey \o Defines the parameters used for querying a subset of all available accounts from the mail store. -\row \o QMailAccountSortKey \o Defines the parameters used for sorting accounts queried from the mail store. -\row \o QMailFolderKey \o Defines the parameters used for querying a subset of all available mail folders from the mail store. -\row \o QMailFolderSortKey \o Defines the parameters used for sorting mail folders queried from the mail store. -\row \o QMailThreadKey \o Defines the parameters used for querying a subset of all available threads from the mail store. -\row \o QMailThreadSortKey \o Defines the parameters used for sorting threads queried from the mail store. -\row \o QMailMessageKey \o Defines the parameters used for querying a subset of all available mail messages from the mail store. -\row \o QMailMessageSortKey \o Defines the parameters used for sorting messages queried from the mail store. +\header \li Class \li Description +\row \li QMailStore \li Represents the main interface for storage and retrieval of messages and folders on the mail store. +\row \li QMailAccountKey \li Defines the parameters used for querying a subset of all available accounts from the mail store. +\row \li QMailAccountSortKey \li Defines the parameters used for sorting accounts queried from the mail store. +\row \li QMailFolderKey \li Defines the parameters used for querying a subset of all available mail folders from the mail store. +\row \li QMailFolderSortKey \li Defines the parameters used for sorting mail folders queried from the mail store. +\row \li QMailThreadKey \li Defines the parameters used for querying a subset of all available threads from the mail store. +\row \li QMailThreadSortKey \li Defines the parameters used for sorting threads queried from the mail store. +\row \li QMailMessageKey \li Defines the parameters used for querying a subset of all available mail messages from the mail store. +\row \li QMailMessageSortKey \li Defines the parameters used for sorting messages queried from the mail store. \endtable \section1 Message Content Management Plugins @@ -165,11 +165,11 @@ Message content can be stored externally to the QMailStore that contains the mes Classes supporting the use of plugins for message content management: \table -\header \o Class \o Description -\row \o QMailContentManager \o Defines the interface to objects that provide a message content management service -\row \o QMailContentManagerFactory \o Creates objects implementing the QMailContentManager interface -\row \o QMailContentManagerPlugin \o Defines a base class for implementing message content management plug-ins -\row \o QMailContentManagerPluginInterface \o Defines the interface to plug-ins that provide message content managers +\header \li Class \li Description +\row \li QMailContentManager \li Defines the interface to objects that provide a message content management service +\row \li QMailContentManagerFactory \li Creates objects implementing the QMailContentManager interface +\row \li QMailContentManagerPlugin \li Defines a base class for implementing message content management plug-ins +\row \li QMailContentManagerPluginInterface \li Defines the interface to plug-ins that provide message content managers \endtable \section1 Message Transport Service @@ -206,10 +206,10 @@ The Client library requires SQL support either through the included SQLite or th The QMF package contains some example programs that demonstrate how to use the library's functionality. \table -\header \o Name \o Description -\row \o qtmail \o Demonstrates how to build a mail client application. -\row \o messagingaccounts \o Demonstrates how to build a stand alone accounts configuration application. -\row \o serverobserver \o Demonstrates how to build a stand alone application that observes actions being performed by the messageserver process. +\header \li Name \li Description +\row \li qtmail \li Demonstrates how to build a mail client application. +\row \li messagingaccounts \li Demonstrates how to build a stand alone accounts configuration application. +\row \li serverobserver \li Demonstrates how to build a stand alone application that observes actions being performed by the messageserver process. \endtable \section1 Changes Between Versions diff --git a/doc/src/qtopiamail_messageserver.qdoc b/doc/src/qtopiamail_messageserver.qdoc index 92541581..8363fae9 100644 --- a/doc/src/qtopiamail_messageserver.qdoc +++ b/doc/src/qtopiamail_messageserver.qdoc @@ -43,9 +43,9 @@ For detailed class information refer to: \l{Message Server Support Classes}. The Message Server Support Library provides classes for storing information about messaging accounts both outgoing and incoming. \table -\header \o Class \o Description -\row \o QMailServiceConfiguration \o Provides an interface to the configuration details for a service within an account. -\row \o QMailStoreAccountFilter \o Forward the signals of QMailStore, filtering for those that affect a single account. +\header \li Class \li Description +\row \li QMailServiceConfiguration \li Provides an interface to the configuration details for a service within an account. +\row \li QMailStoreAccountFilter \li Forward the signals of QMailStore, filtering for those that affect a single account. \endtable \section1 Message Services @@ -53,13 +53,13 @@ The Message Server Support Library provides classes for storing information abou The library provides classes that assist with the development of services that can be loaded into the {MessageServer Daemon}{Message Server} daemon via plugins. \table -\header \o Class \o Description -\row \o QMailMessageService \o The interface between the message server and components loaded from plugin libraries. -\row \o QMailMessageSink \o The interface to objects that provide message external transmission services to the messageserver. -\row \o QMailMessageSource \o The interface to objects that provide access to externally sourced messages to the messageserver. -\row \o QMailMessageServiceEditor \o Interface that allows a service to be edited graphically. -\row \o QMailMessageServiceConfigurator \o Interface that allows a service to be configured. -\row \o QMailMessageServiceFactory \o Creates objects implementing the QMailMessageService interface. +\header \li Class \li Description +\row \li QMailMessageService \li The interface between the message server and components loaded from plugin libraries. +\row \li QMailMessageSink \li The interface to objects that provide message external transmission services to the messageserver. +\row \li QMailMessageSource \li The interface to objects that provide access to externally sourced messages to the messageserver. +\row \li QMailMessageServiceEditor \li Interface that allows a service to be edited graphically. +\row \li QMailMessageServiceConfigurator \li Interface that allows a service to be configured. +\row \li QMailMessageServiceFactory \li Creates objects implementing the QMailMessageService interface. \endtable \section1 Utility Classes @@ -67,9 +67,9 @@ The library provides classes that assist with the development of services that c The library also provides some utility classes that are used by service components within the Message Server daemon. \table -\header \o Class \o Description -\row \o QMailTransport \o A class that provides an encrypted line-oriented communications channel. -\row \o QMailMessageClassifier \o A class that classifies message content by inspection. +\header \li Class \li Description +\row \li QMailTransport \li A class that provides an encrypted line-oriented communications channel. +\row \li QMailMessageClassifier \li A class that classifies message content by inspection. \endtable \section1 Changes Between Versions diff --git a/doc/src/qtopiamail_qmfutil.qdoc b/doc/src/qtopiamail_qmfutil.qdoc index 60860cde..9a10adc3 100644 --- a/doc/src/qtopiamail_qmfutil.qdoc +++ b/doc/src/qtopiamail_qmfutil.qdoc @@ -45,8 +45,8 @@ Together with the model classes provided by the \l{Messaging Framework Client Li display lists of messages and accounts with minimal effort, and with minimal resource consumption. \table -\header \o Class \o Description -\row \o QMailMessageDelegate \o Provides a standard visual representation of a message in a list view. +\header \li Class \li Description +\row \li QMailMessageDelegate \li Provides a standard visual representation of a message in a list view. \endtable \section1 New Message Arrival Service @@ -59,8 +59,8 @@ can be instantiated to permit a client application to respond to the arrival of \section1 Examples \table -\header \o Name \o Description -\row \o \l{MessageViewer Example}{MessageViewer} \o Demonstrates the use of QMailMessageMetaData and QMailMessageKey in finding and viewing messages. +\header \li Name \li Description +\row \li \l{MessageViewer Example}{MessageViewer} \li Demonstrates the use of QMailMessageMetaData and QMailMessageKey in finding and viewing messages. \endtable */ diff --git a/src/libraries/qmfclient/qmailaccountconfiguration.cpp b/src/libraries/qmfclient/qmailaccountconfiguration.cpp index 5695f84c..720b45df 100644 --- a/src/libraries/qmfclient/qmailaccountconfiguration.cpp +++ b/src/libraries/qmfclient/qmailaccountconfiguration.cpp @@ -129,10 +129,10 @@ private: retrieval protocols should behave similarly. \table - \header \o Desired retrieval behavior \o Required key/value pair settings - \row \o Headers only \o "downloadAttachments" = "0", "autoDownload" = "0", "maxSize" = "0" - \row \o Entire message including attachments \o "downloadAttachments" = "1", "autoDownload" = "1", "maxSize" = "0" - \row \o Message headers, body and when available structure, no attachments \o "downloadAttachments" = "0", "autoDownload" = "1", "maxSize" = "0" + \header \li Desired retrieval behavior \li Required key/value pair settings + \row \li Headers only \li "downloadAttachments" = "0", "autoDownload" = "0", "maxSize" = "0" + \row \li Entire message including attachments \li "downloadAttachments" = "1", "autoDownload" = "1", "maxSize" = "0" + \row \li Message headers, body and when available structure, no attachments \li "downloadAttachments" = "0", "autoDownload" = "1", "maxSize" = "0" \endtable Structure refers to MIME body structure information. diff --git a/src/libraries/qmfclient/qmailaction.cpp b/src/libraries/qmfclient/qmailaction.cpp index c6eb081e..e1eb0029 100644 --- a/src/libraries/qmfclient/qmailaction.cpp +++ b/src/libraries/qmfclient/qmailaction.cpp @@ -118,8 +118,7 @@ void QMailActionDataPrivate::deserialize(Stream &stream) /*! \class QMailActionData - \brief The QMailActionData class provides an interface for accessing service action - data + \brief The QMailActionData class provides an interface for accessing service action data. \ingroup messaginglibrary \sa QMailActionInfo diff --git a/src/libraries/qmfclient/qmailaddress.cpp b/src/libraries/qmfclient/qmailaddress.cpp index c37c6ddc..720e741c 100644 --- a/src/libraries/qmfclient/qmailaddress.cpp +++ b/src/libraries/qmfclient/qmailaddress.cpp @@ -869,7 +869,7 @@ void QMailAddressPrivate::deserialize(Stream &stream) QMailMessage class. Address strings are expected to use the format "name_part '<'address_part'>'", where - \i name_part describes a message sender or recipient and \i address_part defines the address + \e name_part describes a message sender or recipient and \e address_part defines the address at which they can be contacted. The address component is not validated, so it can contain an email address, phone number, or any other type of textual address representation. diff --git a/src/libraries/qmfclient/qmailcrypto.cpp b/src/libraries/qmfclient/qmailcrypto.cpp index 1a7297a8..ae4db914 100644 --- a/src/libraries/qmfclient/qmailcrypto.cpp +++ b/src/libraries/qmfclient/qmailcrypto.cpp @@ -276,7 +276,7 @@ QMailCryptographicServiceConfiguration::~QMailCryptographicServiceConfiguration( Returns the keys to be used when creating a cryptographic signature for an e-mail of this account. - \sa QMailCryptographicService::sign(). + \sa QMailCryptographicService::sign() */ QStringList QMailCryptographicServiceConfiguration::signatureKeys() const { @@ -287,7 +287,7 @@ QStringList QMailCryptographicServiceConfiguration::signatureKeys() const Stores the \a keys to be used when creating a cryptographic signature for an e-mail of this account. - \sa QMailCryptographicService::sign(). + \sa QMailCryptographicService::sign() */ void QMailCryptographicServiceConfiguration::setSignatureKeys(const QStringList &keys) { @@ -302,7 +302,7 @@ void QMailCryptographicServiceConfiguration::setSignatureKeys(const QStringList Returns the method to be used when creating a cryptographic signature for an e-mail of this account. - \sa QMailCryptographicService::sign(). + \sa QMailCryptographicService::sign() */ QString QMailCryptographicServiceConfiguration::signatureType() const { @@ -313,7 +313,7 @@ QString QMailCryptographicServiceConfiguration::signatureType() const Sets up the \a method to be used when creating a cryptographic signature for an e-mail of this account. - \sa QMailCryptographicService::sign(). + \sa QMailCryptographicService::sign() */ void QMailCryptographicServiceConfiguration::setSignatureType(const QString &method) { diff --git a/src/libraries/qmfclient/qmailfolder.cpp b/src/libraries/qmfclient/qmailfolder.cpp index c6714881..5bb7965f 100644 --- a/src/libraries/qmfclient/qmailfolder.cpp +++ b/src/libraries/qmfclient/qmailfolder.cpp @@ -437,7 +437,7 @@ QMailFolderId QMailFolder::parentFolderId() const } /*! - Sets the parent folder ID to \a id. \bold{Warning}: it is the responsibility of the + Sets the parent folder ID to \a id. \b{Warning}: it is the responsibility of the application to make sure that no circular folder refernces are created. */ void QMailFolder::setParentFolderId(const QMailFolderId& id) diff --git a/src/libraries/qmfclient/qmailserviceaction.cpp b/src/libraries/qmfclient/qmailserviceaction.cpp index a39a2a7c..f3e2af37 100644 --- a/src/libraries/qmfclient/qmailserviceaction.cpp +++ b/src/libraries/qmfclient/qmailserviceaction.cpp @@ -2378,7 +2378,7 @@ QMailMessageId QMailActionInfoPrivate::statusMessageId() const \preliminary \ingroup messaginglibrary - \brief The QMailActionInfo class provides the interface for tracking individual actions + \brief The QMailActionInfo class provides the interface for tracking individual actions. QMailActionInfo provides the mechanism for messaging clients to track an action that is or has run on the server. QMailActionInfo objects can only be created by QMailActionObserver @@ -2612,7 +2612,7 @@ void QMailActionObserverPrivate::onActivityChanged(quint64 id, QMailServiceActio \preliminary \ingroup messaginglibrary - \brief The QMailActionObserver class provides an interface for monitoring currently running actions + \brief The QMailActionObserver class provides an interface for monitoring currently running actions. QMailActionObserver provides a mechanism for messaging clients to observe what actions the messageserver is currently running. A list of currently running actions can be retrieved diff --git a/src/libraries/qmfmessageserver/qmailcredentials.cpp b/src/libraries/qmfmessageserver/qmailcredentials.cpp index 9f02ae84..1d6d2809 100644 --- a/src/libraries/qmfmessageserver/qmailcredentials.cpp +++ b/src/libraries/qmfmessageserver/qmailcredentials.cpp @@ -218,7 +218,7 @@ QMailCredentialsPlugin::~QMailCredentialsPlugin() \preliminary \ingroup libmessageserver - \brief The QMailCredentialsInterface describes how authentication credentials can be retrieved + \brief The QMailCredentialsInterface describes how authentication credentials can be retrieved. This interface has to be implemented by mechanisms that can retrieve and expose authentication credentials. For instance, credentials can be stored |
