Fix QtLocation documentation

This moves the docs to its proper place and fixes content as well as
broken links.

There are still some warnings left.

Change-Id: Ie83086f4feabab5f3b3d6c92eb6b401a5ff43e29
Reviewed-by: Alex <alexander.blasche@digia.com>

10 files changed, 19 insertions, 20 deletions

diff --git a/src/location/places/qplace.cpp b/src/location/places/qplace.cpp
index 4a9e1d11..63aa6f34 100644
--- a/src/location/places/qplace.cpp
+++ b/src/location/places/qplace.cpp
@@ -59,14 +59,14 @@ QT_BEGIN_NAMESPACE
 
     \brief The QPlace class represents a set of data about a place.
 
-    \include place-definition.qdocinc
+    \input place-definition.qdocinc
 
     \section2 Contact Information
     The contact information of a place is based around a common set of
     \l {Contact Types}{contact types}. To retrieve all the phone numbers
     of a place, one would do:
 
-    \snippet snippets/places/requesthandler.h Phone numbers
+    \snippet places/requesthandler.h Phone numbers
 
     The contact types are string values by design to allow for providers
     to introduce new contact types.
@@ -85,7 +85,7 @@ QT_BEGIN_NAMESPACE
     Similar to contacts attributes are based around a common set of
     \l {Attribute Types}{attribute types}.  To retrieve an extended attribute one
     would do:
-    \snippet snippets/places/requesthandler.h Opening hours
+    \snippet places/requesthandler.h Opening hours
 
     The attribute types are string values by design to allow providers
     to introduce new attribute types.
@@ -114,7 +114,7 @@ QT_BEGIN_NAMESPACE
     the category to be created).
 
     \section2 Saving Caveats
-    \include place-caveats.qdocinc
+    \input place-caveats.qdocinc
 */
 
 /*!
diff --git a/src/location/places/qplacecontent.cpp b/src/location/places/qplacecontent.cpp
index be26d543..4b9b93f7 100644
--- a/src/location/places/qplacecontent.cpp
+++ b/src/location/places/qplacecontent.cpp
@@ -91,7 +91,7 @@ bool QPlaceContentPrivate::compare(const QPlaceContentPrivate *other) const
     Conversion between QPlaceContent and it's subclasses can be easily performed without
     casting. Due to the way it has been implemented, object slicing is not an issue,
     the following code is valid:
-    \snippet snippets/places/requesthandler.h Content conversion
+    \snippet places/requesthandler.h Content conversion
 
     The rich content of a place is typically made available as paginated items.  The ability
     to convert between QPlaceContent and it's subclasses means that code which handles
diff --git a/src/location/places/qplacecontentrequest.cpp b/src/location/places/qplacecontentrequest.cpp
index 5ac66cbe..1353ada4 100644
--- a/src/location/places/qplacecontentrequest.cpp
+++ b/src/location/places/qplacecontentrequest.cpp
@@ -88,10 +88,10 @@ void QPlaceContentRequestPrivate::clear()
     retrieve rich content like images and reviews in a paginated fashion.
     The following code would request a set of 5 images from the 10th index:
 
-    \snippet snippets/places/requesthandler.h Content request
+    \snippet places/requesthandler.h Content request
     \dots
     \dots
-    \snippet snippets/places/requesthandler.h Content handler
+    \snippet places/requesthandler.h Content handler
 
     \sa QPlaceContentReply
 */
diff --git a/src/location/places/qplacedetailsreply.cpp b/src/location/places/qplacedetailsreply.cpp
index 061f3797..d2908ec9 100644
--- a/src/location/places/qplacedetailsreply.cpp
+++ b/src/location/places/qplacedetailsreply.cpp
@@ -65,7 +65,7 @@ QT_USE_NAMESPACE
     \brief The QPlaceDetailsReply class manages a place details fetch operation started by an
     instance of QPlaceManager.
 
-    See \l {Fetching Place Details} for an example on how to use a details reply.
+    See \l {QML Places API#Fetching Place Details}{Fetching Place Details} for an example on how to use a details reply.
     \sa QPlaceManager
 */
 
diff --git a/src/location/places/qplaceicon.cpp b/src/location/places/qplaceicon.cpp
index a7939733..1ae9c14f 100644
--- a/src/location/places/qplaceicon.cpp
+++ b/src/location/places/qplaceicon.cpp
@@ -88,17 +88,16 @@ bool QPlaceIconPrivate::operator == (const QPlaceIconPrivate &other) const
 
     \brief The QPlaceIcon class represents an icon.
 
-    \section2 Usage
     The typical usage of an icon is to use the url() function to specify
     a preferred icon size.
 
-    \snippet snippets/places/requesthandler.h icon
+    \snippet places/requesthandler.h icon
 
     The icons are typically backend dependent, if a manager backend does not support a given size, the URL of the icon that most
     closely matches those parameters is returned.
 
     The icon class also has a key-value set of parameters.  The precise key one
-    needs to use depends on the \l {Qt Location Module#Plugin References and Parameters}{plugin}
+    needs to use depends on the \l {Qt Location#Plugin References and Parameters}{plugin}
     being used.  These parameters influence which icon URL is returned by
     the manager and may also be used to specify icon URL locations when
     saving icons.
@@ -196,7 +195,7 @@ QUrl QPlaceIcon::url(const QSize &size) const
     URL when url() is called and to specify locations to save to
     when saving icons.
 
-    Consult the \l {Qt Location Module#Plugin References and Parameters}{plugin documentation}
+    Consult the \l {Qt Location#Plugin References and Parameters}{plugin documentation}
     for what parameters are supported and how they should be used.
 */
 QVariantMap QPlaceIcon::parameters() const
diff --git a/src/location/places/qplacemanager.cpp b/src/location/places/qplacemanager.cpp
index 61b1cb15..d0e91312 100644
--- a/src/location/places/qplacemanager.cpp
+++ b/src/location/places/qplacemanager.cpp
@@ -106,10 +106,10 @@ QT_BEGIN_NAMESPACE
     contains the results of the request, along with any errors that occurred, if any.
 
     An asynchronous request is generally handled as follows:
-    \snippet snippets/places/requesthandler.h Simple search
+    \snippet places/requesthandler.h Simple search
     \dots
     \dots
-    \snippet snippets/places/requesthandler.h Simple search handler
+    \snippet places/requesthandler.h Simple search handler
 
     See \l {Common Operations} for a list of examples demonstrating how the QPlaceManger
     is used.
@@ -200,7 +200,7 @@ int QPlaceManager::managerVersion() const
 /*!
     Retrieves a details of place corresponding to the given \a placeId.
 
-    See \l {Fetching Place Details} for an example of usage.
+    See \l {QML Places API#Fetching Place Details}{Fetching Place Details} for an example of usage.
 */
 QPlaceDetailsReply *QPlaceManager::getPlaceDetails(const QString &placeId) const
 {
diff --git a/src/location/places/qplaceratings.cpp b/src/location/places/qplaceratings.cpp
index 0cfdca2e..c8467f07 100644
--- a/src/location/places/qplaceratings.cpp
+++ b/src/location/places/qplaceratings.cpp
@@ -82,7 +82,7 @@ bool QPlaceRatingsPrivate::isEmpty() const
     The average() function returns an aggregated ratings value out of a possible
     maximum as given by the maximum() function.
 
-    \snippet snippets/places/requesthandler.h Ratings
+    \snippet places/requesthandler.h Ratings
 */
 
 /*!
diff --git a/src/location/places/qplaceresult.cpp b/src/location/places/qplaceresult.cpp
index 002d94c7..8a3a99fe 100644
--- a/src/location/places/qplaceresult.cpp
+++ b/src/location/places/qplaceresult.cpp
@@ -86,7 +86,7 @@ bool QPlaceResultPrivate::compare(const QPlaceSearchResultPrivate *other) const
     The intended usage is that a QPlaceSearchResult can be converted into a QPlaceResult
     like so:
 
-    \snippet snippets/places/requesthandler.h Convert search result
+    \snippet places/requesthandler.h Convert search result
 
     The implmentation is handled in such a way that object slicing is not an issue.
 
diff --git a/src/location/places/qplacesearchrequest.cpp b/src/location/places/qplacesearchrequest.cpp
index 76393c27..4af49102 100644
--- a/src/location/places/qplacesearchrequest.cpp
+++ b/src/location/places/qplacesearchrequest.cpp
@@ -145,7 +145,7 @@ void QPlaceSearchRequestPrivate::clear()
     \brief The QPlaceSearchRequest class represents the set of parameters for a search request.
 
     A typical search request may look like the following:
-    \snippet snippets/places/requesthandler.h Search request
+    \snippet places/requesthandler.h Search request
 
     Note that specifying a search center can be done by setting a circular search area that has
     a center but no radius.    The default radius is set to -1, which indicates an undefined radius.  The provider will
@@ -160,7 +160,7 @@ void QPlaceSearchRequestPrivate::clear()
 
     Also be aware that providers may vary by which parameters they support for example some providers may not support
     paging while others do, some providers may honor relevance hints while others may completely ignore them,
-    see the \l {Qt Location Module#Plugin References and Parameters}{plugin documentation} for more
+    see the \l {Qt Location#Plugin References and Parameters}{plugin documentation} for more
     details.
 */
 
diff --git a/src/location/places/qplacesearchresult.cpp b/src/location/places/qplacesearchresult.cpp
index 424cba3d..124299f5 100644
--- a/src/location/places/qplacesearchresult.cpp
+++ b/src/location/places/qplacesearchresult.cpp
@@ -84,7 +84,7 @@ bool QPlaceSearchResultPrivate::compare(const QPlaceSearchResultPrivate *other)
     The intended usage is that depending  on the \l {QPlaceSearchResult::type()} {type},
     the search result can be converted to a more detailed subclass like so:
 
-    \snippet snippets/places/requesthandler.h Convert search result
+    \snippet places/requesthandler.h Convert search result
 
     The implmentation is handled in such a way that object slicing is not an issue.
     It is not expected that client applications or backend plugins instantiate