diff options
author | Peter Yard <peter.yard@nokia.com> | 2011-04-15 14:24:20 +1000 |
---|---|---|
committer | Peter Yard <peter.yard@nokia.com> | 2011-04-15 14:24:20 +1000 |
commit | 906c2d9a2f38058693d7a39b234a044724b1d1fc (patch) | |
tree | 19d6df5e612aadcaa77a91a1715a3f75d2017d8c /src/messaging/qmessageid.cpp | |
parent | 2b15ddb74099ff3a9179de0b37f8726add54b133 (diff) |
Docs: added since version to 1.0 classes. QTMOBILITY-790
Diffstat (limited to 'src/messaging/qmessageid.cpp')
-rw-r--r-- | src/messaging/qmessageid.cpp | 25 |
1 files changed, 13 insertions, 12 deletions
diff --git a/src/messaging/qmessageid.cpp b/src/messaging/qmessageid.cpp index e23e03598a..d0e63fa419 100644 --- a/src/messaging/qmessageid.cpp +++ b/src/messaging/qmessageid.cpp @@ -45,24 +45,25 @@ QTM_BEGIN_NAMESPACE /*! \class QMessageId - + \inmodule QtMessaging - + \ingroup messaging + \since 1.0 - \brief The QMessageId class provides a unique identifier for a QMessage message within the + \brief The QMessageId class provides a unique identifier for a QMessage message within the scope of the messaging store. A QMessageId can be constructed from a string, or converted to a string with toString(). A QMessageId instance can be tested for validity with isValid(), and compared to other instances for equality. - - If the message a QMessageId identifies is removed from the messaging store then the identifier + + If the message a QMessageId identifies is removed from the messaging store then the identifier will not be reused. - + The QMessageId implementation should be as small as is practical for the underlying platform. - + \sa QMessage, QMessageManager */ @@ -82,13 +83,13 @@ QTM_BEGIN_NAMESPACE \fn QMessageId::QMessageId(const QString& id) Constructs an identifier from \a id. - + \sa toString() */ /*! \fn QMessageId::~QMessageId() - + Destroys the identifier. */ @@ -118,10 +119,10 @@ bool QMessageId::operator!=(const QMessageId &other) const \fn bool QMessageId::toString() const Returns the string representation of this identifier. - + A null string should be returned if and only if the identifier is invalid. - - String representations of identifiers should not be used to test for equality, instead + + String representations of identifiers should not be used to test for equality, instead the equality operator should be used. */ |