diff options
author | Peter Yard <peter.yard@nokia.com> | 2011-04-15 16:22:50 +1000 |
---|---|---|
committer | Peter Yard <peter.yard@nokia.com> | 2011-04-15 16:22:50 +1000 |
commit | 5107308dc3224db69770e554c1b470c35cc92cdf (patch) | |
tree | 1f1b6d77cf82b28d7f535b560792caf081640ae3 /src/location/qgeoboundingarea.cpp | |
parent | 906c2d9a2f38058693d7a39b234a044724b1d1fc (diff) |
Docs: QTMOBILITY-790 added since tag for 1.1 Classes.
Diffstat (limited to 'src/location/qgeoboundingarea.cpp')
-rw-r--r-- | src/location/qgeoboundingarea.cpp | 15 |
1 files changed, 8 insertions, 7 deletions
diff --git a/src/location/qgeoboundingarea.cpp b/src/location/qgeoboundingarea.cpp index ed4736847b..1f256be676 100644 --- a/src/location/qgeoboundingarea.cpp +++ b/src/location/qgeoboundingarea.cpp @@ -48,14 +48,15 @@ QTM_BEGIN_NAMESPACE \brief The QGeoBoundingArea class defines a geographic area. \inmodule QtLocation + \since 1.1 \ingroup maps - This class is the base class for classes which specify a geographic - area. - + This class is the base class for classes which specify a geographic + area. + For the sake of consistency, subclasses should describe the specific - details of the associated areas in terms of QGeoCoordinate instances + details of the associated areas in terms of QGeoCoordinate instances and distances in metres. */ @@ -85,8 +86,8 @@ Returns the type of this area. Returns whether this bounding area is valid. -An area is considered to be invalid if some of the data that is required to -unambiguously describe the area has not been set or has been set to an +An area is considered to be invalid if some of the data that is required to +unambiguously describe the area has not been set or has been set to an unsuitable value. */ @@ -101,7 +102,7 @@ An empty area is a region which has a geometrical area of 0. /*! \fn bool QGeoBoundingArea::contains(const QGeoCoordinate &coordinate) const -Returns whether the coordinate \a coordinate is contained within this +Returns whether the coordinate \a coordinate is contained within this area. */ |