diff options
author | Casper van Donderen <casper.vandonderen@nokia.com> | 2012-03-01 18:48:30 +0100 |
---|---|---|
committer | Qt by Nokia <qt-info@nokia.com> | 2012-03-02 16:10:52 +0100 |
commit | 9856dfc1ef8d130a86e0684a9f0d1e1ec5980fcd (patch) | |
tree | 25e3b0d2e697326966a32dba899621f598566772 /src/location | |
parent | a88efc755d83a8c1ce4935271f4d55669ad0dd83 (diff) | |
download | qtlocation-9856dfc1ef8d130a86e0684a9f0d1e1ec5980fcd.tar.gz |
Remove the usage of deprecated qdoc macros.
QDoc now has support for Doxygen style commands for italics, bold
and list items. This change applies that change in QDoc to the
actual documentation.
Task-number: QTBUG-24578
Change-Id: If6af8e9303bdb7c255cce086b93073d927ac2907
Reviewed-by: Alex <alex.blasche@nokia.com>
Diffstat (limited to 'src/location')
-rw-r--r-- | src/location/places/qplace.cpp | 8 | ||||
-rw-r--r-- | src/location/places/qplaceattribute.cpp | 14 | ||||
-rw-r--r-- | src/location/places/qplacecontactdetail.cpp | 16 | ||||
-rw-r--r-- | src/location/places/qplacecontent.cpp | 4 | ||||
-rw-r--r-- | src/location/places/qplacemanager.cpp | 40 | ||||
-rw-r--r-- | src/location/qgeocoordinate.cpp | 28 | ||||
-rw-r--r-- | src/location/qgeopositioninfosource.cpp | 2 | ||||
-rw-r--r-- | src/location/qnmeapositioninfosource.cpp | 2 |
8 files changed, 57 insertions, 57 deletions
diff --git a/src/location/places/qplace.cpp b/src/location/places/qplace.cpp index 27fa1781..b90bb1d2 100644 --- a/src/location/places/qplace.cpp +++ b/src/location/places/qplace.cpp @@ -74,10 +74,10 @@ QT_BEGIN_NAMESPACE For convenience there are a set of functions which return the value of the first contact detail of each type. \list - \o QPlace::primaryPhone() - \o QPlace::primaryEmail() - \o QPlace::primaryWebsite() - \o QPlace::primaryFax() + \li QPlace::primaryPhone() + \li QPlace::primaryEmail() + \li QPlace::primaryWebsite() + \li QPlace::primaryFax() \endlist \section2 Extended Attributes diff --git a/src/location/places/qplaceattribute.cpp b/src/location/places/qplaceattribute.cpp index b96a9428..d5423283 100644 --- a/src/location/places/qplaceattribute.cpp +++ b/src/location/places/qplaceattribute.cpp @@ -82,9 +82,9 @@ bool QPlaceAttributePrivate::operator== (const QPlaceAttributePrivate &other) co \section2 Attribute Types The QPlaceAttribute class defines some constant strings which characterize standard \e {attribute types}. \list - \o QPlaceAttribute::OpeningHours - \o QPlaceAttribute::Payment - \o QPlaceAttribute::Provider + \li QPlaceAttribute::OpeningHours + \li QPlaceAttribute::Payment + \li QPlaceAttribute::Provider \endlist There is a class of attribute types of the format x_id_<provider> e.g. x_id_nokia. @@ -93,10 +93,10 @@ bool QPlaceAttributePrivate::operator== (const QPlaceAttributePrivate &other) co The above types are used to access and modify attributes in QPlace via: \list - \o QPlace::extendedAttribute() - \o QPlace::setExtendedAttribute() - \o QPlace::removeExtendedAttribute() - \o QPlace::removeExtendedAttribute() + \li QPlace::extendedAttribute() + \li QPlace::setExtendedAttribute() + \li QPlace::removeExtendedAttribute() + \li QPlace::removeExtendedAttribute() \endlist The \e {attribute type} is a string type so that providers are able to introduce diff --git a/src/location/places/qplacecontactdetail.cpp b/src/location/places/qplacecontactdetail.cpp index fdf7d15f..c18c2af0 100644 --- a/src/location/places/qplacecontactdetail.cpp +++ b/src/location/places/qplacecontactdetail.cpp @@ -72,18 +72,18 @@ to the end user that describes that detail value which is the actual phone numbe The QPlaceContactDetail class defines some constant strings which characterize standard \e {contact types}. \list - \o QPlaceContactDetail::Phone - \o QPlaceContactDetail::Email - \o QPlaceContactDetail::Website - \o QPlaceContactDetail::Fax + \li QPlaceContactDetail::Phone + \li QPlaceContactDetail::Email + \li QPlaceContactDetail::Website + \li QPlaceContactDetail::Fax \endlist These types are used to access and modify contact details in QPlace via: \list - \o QPlace::contactDetails() - \o QPlace::setContactDetails() - \o QPlace::appendContactDetail() - \o QPlace::contactTypes() + \li QPlace::contactDetails() + \li QPlace::setContactDetails() + \li QPlace::appendContactDetail() + \li QPlace::contactTypes() \endlist The \e {contact type} is intended to be a string type so that providers are able to introduce new contact diff --git a/src/location/places/qplacecontent.cpp b/src/location/places/qplacecontent.cpp index 47ce1501..9d839386 100644 --- a/src/location/places/qplacecontent.cpp +++ b/src/location/places/qplacecontent.cpp @@ -87,7 +87,7 @@ bool QPlaceContentPrivate::compare(const QPlaceContentPrivate *other) const a user from a supplier is contributing content, hence both fields could be filled in simultaneously. - \bold {Note:} Some providers may \e {require} that the attribution string be displayed + \b {Note:} Some providers may \e {require} that the attribution string be displayed to the user whenever a piece of content is viewed. Conversion between QPlaceContent and it's subclasses can be easily performed without @@ -240,7 +240,7 @@ void QPlaceContent::setUser(const QPlaceUser &user) /*! Returns a rich text attribution string. - \bold {Note}: Some providers may require that the attribution + \b {Note}: Some providers may require that the attribution of a particular content item always be displayed when the content item is shown. */ diff --git a/src/location/places/qplacemanager.cpp b/src/location/places/qplacemanager.cpp index 158c8bae..cfbb5137 100644 --- a/src/location/places/qplacemanager.cpp +++ b/src/location/places/qplacemanager.cpp @@ -59,35 +59,35 @@ QT_BEGIN_NAMESPACE The following table gives an overview of the functionality provided by the QPlaceManager \table \header - \o Functionality - \o Description + \li Functionality + \li Description \row - \o Searching for places - \o Using set of parameters such as a search term and search area, relevant places + \li Searching for places + \li Using set of parameters such as a search term and search area, relevant places can be returned to the user. \row - \o Categories - \o Places can be classified as belonging to different categories. The + \li Categories + \li Places can be classified as belonging to different categories. The manager supports access to these categories. \row - \o Search term suggestions - \o Given a partially complete search term, a list of potential + \li Search term suggestions + \li Given a partially complete search term, a list of potential search terms can be given. \row - \o Recommendations - \o Given an existing place, a set of similar recommended places can + \li Recommendations + \li Given an existing place, a set of similar recommended places can be suggested to the user. \row - \o Rich Content - \o Rich content such as images, reviews etc can be retrieved in a paged + \li Rich Content + \li Rich content such as images, reviews etc can be retrieved in a paged fashion. \row - \o Place/Category management - \o Places and categories may be saved and removed. It is possible + \li Place/Category management + \li Places and categories may be saved and removed. It is possible for notifications to be given when this happens. \row - \o Localization - \o Different locales may be specified to return place + \li Localization + \li Different locales may be specified to return place data in different languages. \endtable @@ -119,10 +119,10 @@ QT_BEGIN_NAMESPACE following functions: \list - \o QPlaceManager::childCategories() - \o QPlaceManager::category() - \o QPlaceManager::parentCategoryId() - \o QPlaceManager::childCategoryIds(); + \li QPlaceManager::childCategories() + \li QPlaceManager::category() + \li QPlaceManager::parentCategoryId() + \li QPlaceManager::childCategoryIds(); \endlist If the categories need to be refreshed or reloaded, the initializeCategories() function diff --git a/src/location/qgeocoordinate.cpp b/src/location/qgeocoordinate.cpp index 86d78961..4902a493 100644 --- a/src/location/qgeocoordinate.cpp +++ b/src/location/qgeocoordinate.cpp @@ -454,26 +454,26 @@ QGeoCoordinate QGeoCoordinate::atDistanceAndAzimuth(qreal distance, qreal azimut \table \header - \o \a format value - \o Returned string + \li \a format value + \li Returned string \row - \o \l Degrees - \o -27.46758\unicode{0xB0}, 153.02789\unicode{0xB0}, 28.1m + \li \l Degrees + \li -27.46758\unicode{0xB0}, 153.02789\unicode{0xB0}, 28.1m \row - \o \l DegreesWithHemisphere - \o 27.46758\unicode{0xB0} S, 153.02789\unicode{0xB0} E, 28.1m + \li \l DegreesWithHemisphere + \li 27.46758\unicode{0xB0} S, 153.02789\unicode{0xB0} E, 28.1m \row - \o \l DegreesMinutes - \o -27\unicode{0xB0} 28.054', 153\unicode{0xB0} 1.673', 28.1m + \li \l DegreesMinutes + \li -27\unicode{0xB0} 28.054', 153\unicode{0xB0} 1.673', 28.1m \row - \o \l DegreesMinutesWithHemisphere - \o 27\unicode{0xB0} 28.054 S', 153\unicode{0xB0} 1.673' E, 28.1m + \li \l DegreesMinutesWithHemisphere + \li 27\unicode{0xB0} 28.054 S', 153\unicode{0xB0} 1.673' E, 28.1m \row - \o \l DegreesMinutesSeconds - \o -27\unicode{0xB0} 28' 3.2", 153\unicode{0xB0} 1' 40.4", 28.1m + \li \l DegreesMinutesSeconds + \li -27\unicode{0xB0} 28' 3.2", 153\unicode{0xB0} 1' 40.4", 28.1m \row - \o \l DegreesMinutesSecondsWithHemisphere - \o 27\unicode{0xB0} 28' 3.2" S, 153\unicode{0xB0} 1' 40.4" E, 28.1m + \li \l DegreesMinutesSecondsWithHemisphere + \li 27\unicode{0xB0} 28' 3.2" S, 153\unicode{0xB0} 1' 40.4" E, 28.1m \endtable The altitude field is omitted if no altitude is set. diff --git a/src/location/qgeopositioninfosource.cpp b/src/location/qgeopositioninfosource.cpp index 61bdda15..30f2631c 100644 --- a/src/location/qgeopositioninfosource.cpp +++ b/src/location/qgeopositioninfosource.cpp @@ -334,7 +334,7 @@ int QGeoPositionInfoSource::updateInterval() const If \a methods does not include any methods supported by the source, the preferred methods will be set to the set of methods which the source supports. - \bold {Note:} When reimplementing this method, subclasses must call the + \b {Note:} When reimplementing this method, subclasses must call the base method implementation to ensure preferredPositioningMethods() returns the correct value. \sa supportedPositioningMethods() diff --git a/src/location/qnmeapositioninfosource.cpp b/src/location/qnmeapositioninfosource.cpp index 760a06d4..6cc22384 100644 --- a/src/location/qnmeapositioninfosource.cpp +++ b/src/location/qnmeapositioninfosource.cpp @@ -518,7 +518,7 @@ QNmeaPositionInfoSource::UpdateMode QNmeaPositionInfoSource::updateMode() const The source device can only be set once and must be set before calling startUpdates() or requestUpdate(). - \bold {Note:} The \a device must emit QIODevice::readyRead() for the + \b {Note:} The \a device must emit QIODevice::readyRead() for the source to be notified when data is available for reading. QNmeaPositionInfoSource does not assume the ownership of the device, and hence does not deallocate it upon destruction. |