From 1b93bcee7ee89249fe8e3b496acb717a5e217d72 Mon Sep 17 00:00:00 2001
From: Bruno de Oliveira Abinader <bruno@mapbox.com>
Date: Mon, 20 Nov 2017 12:05:27 +0200
Subject: [Qt] Update documentation

---
 platform/qt/include/qmapbox.hpp |  4 ++++
 platform/qt/src/qmapboxgl.cpp   | 14 ++++++++------
 2 files changed, 12 insertions(+), 6 deletions(-)

diff --git a/platform/qt/include/qmapbox.hpp b/platform/qt/include/qmapbox.hpp
index d138f4057b..2bb5d8705c 100644
--- a/platform/qt/include/qmapbox.hpp
+++ b/platform/qt/include/qmapbox.hpp
@@ -27,6 +27,7 @@ struct Q_DECL_EXPORT Feature {
         PolygonType
     };
 
+    /*! Class constructor. */
     Feature(Type type_ = PointType, const CoordinatesCollections& geometry_ = CoordinatesCollections(),
             const QVariantMap& properties_ = QVariantMap(), const QVariant& id_ = QVariant())
         : type(type_), geometry(geometry_), properties(properties_), id(id_) {}
@@ -45,6 +46,7 @@ struct Q_DECL_EXPORT ShapeAnnotationGeometry {
         MultiPolygonType
     };
 
+    /*! Class constructor. */
     ShapeAnnotationGeometry(Type type_ = LineStringType, const CoordinatesCollections& geometry_ = CoordinatesCollections())
         : type(type_), geometry(geometry_) {}
 
@@ -58,6 +60,7 @@ struct Q_DECL_EXPORT SymbolAnnotation {
 };
 
 struct Q_DECL_EXPORT LineAnnotation {
+    /*! Class constructor. */
     LineAnnotation(const ShapeAnnotationGeometry& geometry_ = ShapeAnnotationGeometry(), float opacity_ = 1.0f,
             float width_ = 1.0f, const QColor& color_ = Qt::black)
         : geometry(geometry_), opacity(opacity_), width(width_), color(color_) {}
@@ -69,6 +72,7 @@ struct Q_DECL_EXPORT LineAnnotation {
 };
 
 struct Q_DECL_EXPORT FillAnnotation {
+    /*! Class constructor. */
     FillAnnotation(const ShapeAnnotationGeometry& geometry_ = ShapeAnnotationGeometry(), float opacity_ = 1.0f,
             const QColor& color_ = Qt::black, const QVariant& outlineColor_ = QVariant())
         : geometry(geometry_), opacity(opacity_), color(color_), outlineColor(outlineColor_) {}
diff --git a/platform/qt/src/qmapboxgl.cpp b/platform/qt/src/qmapboxgl.cpp
index c9f85adf4c..cc1d88e22f 100644
--- a/platform/qt/src/qmapboxgl.cpp
+++ b/platform/qt/src/qmapboxgl.cpp
@@ -155,9 +155,11 @@ std::unique_ptr<mbgl::style::Image> toStyleImage(const QString &id, const QImage
     reset before each rendering. Use this mode if the intention is to only draw a
     fullscreen map.
 
-    \value SharedGLContext  The OpenGL context is shared and the state will be restored
-    before rendering. This mode is safer when OpenGL calls are performed prior of after
-    we call QMapboxGL::render for rendering a map.
+    \value SharedGLContext  The OpenGL context is shared and the state will be
+    marked dirty - which invalidates any previously assumed GL state. The
+    embedder is responsible for clearing up the viewport prior to calling
+    QMapboxGL::render. The embedder is also responsible for resetting its own
+    GL state after QMapboxGL::render has finished, if needed.
 
     \sa contextMode()
 */
@@ -386,7 +388,7 @@ std::function<std::string(const std::string &&)> QMapboxGLSettings::resourceTran
 }
 
 /*!
-    Sets the resource transformation callback.
+    Sets the resource \a transform callback.
 
     When given, resource transformation callback will be used to transform the
     requested resource URLs before they are requested from internet. This can be
@@ -887,7 +889,7 @@ void QMapboxGL::removeAnnotation(QMapbox::AnnotationID id)
 }
 
 /*!
-    Sets a layout \a property \a value to an existing \a layer. The \a property_ string can be any
+    Sets a layout \a property_ \a value to an existing \a layer. The \a property_ string can be any
     as defined by the \l {https://www.mapbox.com/mapbox-gl-style-spec/} {Mapbox style specification}
     for layout properties.
 
@@ -938,7 +940,7 @@ void QMapboxGL::setLayoutProperty(const QString& layer, const QString& property_
 }
 
 /*!
-    Sets a paint \a property_ \a value to an existing \a layer. The \a property string can be any
+    Sets a paint \a property_ \a value to an existing \a layer. The \a property_ string can be any
     as defined by the \l {https://www.mapbox.com/mapbox-gl-style-spec/} {Mapbox style specification}
     for paint properties.
 
-- 
cgit v1.2.1